欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

在Asp.Net MVC项目中创建一个API

程序员文章站 2022-04-02 18:17:44
...

最近在忙一个MVC项目,Leader要求创建一个API,可通过某个link获得某个记录的信息。

本来想通过View来返回一个JSON记录,当我创建Controller时发现有一个API Controller,想必是MVC已经具备这个功能了,所以抱着试一试的心态,迅速补习了一下MVC API知识,马上现学现卖。

选择Controller文件夹,右键,选择Add...,选择API

在Asp.Net MVC项目中创建一个API


命名未ABCController.cs, 并加入以下代码,注意方法GetUser,一定要求[HttpGet]修饰,其中key和username是要传入的参数。

public class ABCController : ApiController
{
    public ABCController()
    {

    }

    [HttpGet]
    public IEnumerable<Models.User> GetUser(string key, string username)
    {
        Models.User user;
        ......
        Models.User[] users = new Models.User[] { user };
        return users;
    }
}

代码很简单,debug调试,通过网址http://localhost:12345/API/ABC/GetUser?key=...&username=abc访问API,这个link返回的是一个XML网页,虽然不是JSON,但处理起来也很方便。注意link中的\API\路径是固定的。为了保证安全性,我增加了key**,可使用GUID来代替,只有提供了正确的key才能得到结果。



相关标签: MVC API