Web API 简单示例

一、RESTful和Web API

　　Representational State Transfer (REST) is a software architecture style consisting of guidelines and best practices for creating scalable web services. REST is a coordinated set of constraints applied to the design of components in a distributed hypermdedia system that can lead to a more performant and maintainable architecture. 　-- wikipedia　

　　ASP.NET Web API is a framework that makes it easy to build HTTP services that reach a broad range of clients, including browsers and mobile devices. ASP.NET Web API is an ideal platform for building RESTful applications on the .NET Framework.

　　原来RESTful是一种软件架构风格（REST是一种设计风格，而不是一种标准），而ASP.NET Web API是其在.NET平台的一种标准/实现。目前在三种主流的Web Services实现方案中，因为REST模式与复杂的SOAP和XML -PRC相比更加简洁，越来越多的web服务开始采用REST风格设计和实现。

　　ASP.NET整体框架结构如下图。可以看出，Web API支持JSON和XML，面向的是多种客户终端，包括多浏览器和各种移动设备。

二、简单示例

　　新建ASP.NET Web Application，命名NBAApp

　　选择Empty模板，下面选择Web API，更改Authentication为No Authentication

　　新建一个Model - Player

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;namespace NBAApp.Models
{public class Player{public int Id { get; set; }public int No { get; set; }public string Name { get; set; }public string Position { get; set; }public string Team { get; set; }}
}

　　新建Controller - PlayersController，模板选择Web API 2 Controller - Empty

　　编辑代码如下

using NBAApp.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;namespace NBAApp.Controllers
{public class PlayersController : ApiController{Player[] players = new Player[] { new Player { Id = 1, No = 3, Name = "Chris Paul", Position = "Point Guard", Team = "Los Angeles Clippers" },new Player { Id = 2, No = 3, Name = "Dwyane Wade", Position = "Shooting Guard", Team = "Miami Heat" },new Player { Id = 3, No = 23, Name = "LeBron James", Position = "Forward", Team = "Cleveland Cavaliers" },new Player { Id = 4, No = 21, Name = "Tim Duncan", Position = "Power forward", Team = "San Antonio Spurs" },new Player { Id = 5, No = 33, Name = "Marc Gasol", Position = "Center", Team = "Memphis Grizzlies" }};public IEnumerable<Player> GetAllPlayers(){return players;}public IHttpActionResult GetPlayer(int id){var player = players.FirstOrDefault<Player>(p => p.Id == id);if (player == null){return NotFound();}return Ok(player);}}
}

　　添加Html - Index.html页面

　　编辑代码如下

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head><title>NBA App</title>
</head>
<body><div><h2>All Players</h2><ul id="players" /></div><div><h2>Search by ID</h2><input type="text" id="prodId" size="5" /><input type="button" value="Search" onclick="find();" /><p id="player" /></div><script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-2.0.3.min.js"></script><script>var uri = 'api/players';$(document).ready(function () {// Send an AJAX request
            $.getJSON(uri).done(function (data) {// On success, 'data' contains a list of players.
                    $.each(data, function (key, item) {// Add a list item for the player.
                        $('<li>', { text: formatItem(item) }).appendTo($('#players'));});});});function formatItem(item) {return item.Id + ": " + item.Name + "(" + item.No + ')' + " - " + item.Team + "(" + item.Position + ")";}function find() {var id = $('#prodId').val();$.getJSON(uri + '/' + id).done(function (data) {$('#player').text(formatItem(data));}).fail(function (jqXHR, textStatus, err) {$('#player').text('Error: ' + err);});}</script>
</body>
</html>

　　执行效果如下（Chrome浏览器）

　　F12调出Developer Tools，点击红点Recording Network Log，刷新页面，结果如下

　　点击进去，并选择Response标签，可以清楚地看到传输交换的是JSON格式的字符

代码下载

NBAApp

转载于:https://www.cnblogs.com/panchunting/p/WebAPI_Demo.html

Web API 简单示例相关推荐

ASP.NET Web API 开篇示例介绍
ASP.NET Web API 开篇示例介绍 ASP.NET Web API 对于我这个初学者来说ASP.NET Web API这个框架很陌生又熟悉着. 陌生的是ASP.NET Web API是一个全 ...
语义web一些简单示例
语义web一些简单示例示例1 (xml部分-用xml描述书籍信息) 题目:写出三本书,每本书有:标题,作者,出版社,出版日期,,,,,:写出对应的XML文件:根据你写的XML文件,写出对应的DTD文 ...
ASP.NET Web API简单学习
Web API 简介 Web API可以返回 json.xml类型的数据,对于数据的增删改查,提供了对应的资源操作,按照要求的类型进行处理,主要包括:Get(查),Post(增),Put(改),Del ...
ASP.net Web API综合示例
目录概述功能介绍程序结构服务器端介绍客户端介绍 "契约" Web API设计规则并行写入冲突与时间戳身份验证详解 Web API验证规则客户端MVVM简介 Web. ...
java调用百度地图api简单示例--获取国内任意两地之间距离
老师让我们从百度地图的api上获取数据源最为两地运输距离,结果百度地图api的开发文档居然连个示例都没有...于是上网找了半天,都是一百多行的源码,我就想用个api,你给我这玩意???终于最后还是找到 ...
php post调用api,PHP（CURL）POST数据调用API简单示例
/** *@一个完整的POST调用API的过程百度知道 *@author: bo.xiao */ $url = 'http://zhidao.chanjet.com/restserver/zhida ...
Linux下MySQL C API简单示例
2019独角兽企业重金招聘Python工程师标准>>> 1. 创建数据库 drop database testdb; commit;create database testdb; c ...
java web service简单示例
http://www.iteye.com/topic/1135747 转载于:https://www.cnblogs.com/fycct/p/5669420.html
使用Http-Repl工具测试ASP.NET Core 2.2中的Web Api项目
今天,Visual Studio中没有内置工具来测试WEB API.使用浏览器,只能测试http GET请求.您需要使用Postman,SoapUI,Fiddler或Swagger等第三方工具来执行W ...

Web API 简单示例

Web API 简单示例相关推荐

最新文章

热门文章