.net core api +swagger(一个简单的入门demo 使用codefirst+mysql)

前言：

自从.net core问世之后，就一直想了解。但是由于比较懒惰只是断断续续了解一点。近段时间工作不是太忙碌，所以偷闲写下自己学习过程。慢慢了解.net core 等这些基础方面学会之后再用.net core写一个项目，前期文章都是为之后的项目做准备。同时也希望这些基础文章能帮助更多的想入手 .net core的小白。(文中如有不正确地方欢迎各位指正)

 

开发工具vs2017

数据库  mysql8.0

.net core环境 .net core2.1

 

1】model层建立

　　先新建一个项目：左侧目录选择其他项目类型=》vs解决方案=》空白方案=》自己随意去个名字

　　添加一个core 内库作为model层，

　　由于本次数据库使用的是mysql，所以在model层中通过nuget分别引用microsoft.entityframeworkcore.tools和pomelo.entityframeworkcore.mysql（注意两个版本必须一致 这里选自2.1.4版本，之前博主引用版本不对，直接导致连接输出出错）

　　然后分别添加一个model类和数据库上下文类，本demo创建一张user表

 

数据库上下文类database

using microsoft.entityframeworkcore;

namespace core.model
{
    public class database : dbcontext
    {
        //构造方法
        public database(dbcontextoptions<database> options)
            : base(options)
        { }

        #region 数据区域
        public dbset<user> user { get; set; }
        #endregion

    }
}

view code

 至此，model创建完毕，后期各位可以根据自己的需要自己拓展

 

2】创建api层

　　首先在解决方案中创建api层，流程如下图

建议新手选择api这一项，创建完毕之后，项目结构如右图

 　　别忘记在api层添加对model层的引用

　　首先来appsettings.json配置数据库，127.0.0.1代表本地计算机

 

　　配置完毕之后来到 startup.cs的configureservices方法将数据库连接配置好，如果此段代码有飘红部分，只需要将其缺失的地方引用（需要引用

using microsoft.entityframeworkcore;和using core.model;）

   //mysql连接
            services.adddbcontextpool<database>(options =>
options.usemysql(configuration.getconnectionstring("mysqlconnection")));

view code

注意括号中的mysqlconnection就是appsettings.json中写连接数据库字符串的前缀

 

 

 

接下来将原有的控制器删除，自己添加一个usercontroller.cs

控制器中代码（包含增删查改crud）

using system;
using system.collections.generic;
using system.linq;
using system.threading.tasks;
using core.model;
using microsoft.aspnetcore.http;
using microsoft.aspnetcore.mvc;

namespace core.api.controllers
{
    [produces("application/json")]
    [route("api/admin/[controller]")]
    [apicontroller]
    public class usercontroller : controller
    {

        private readonly database _context;
        public usercontroller(database context)
        {
            _context = context;
        }
        #region base

        /// <summary>
        /// 获取单个
        /// </summary>
        /// <param name="id">id</param>
        /// <returns></returns>
        [httpget("{id}")]
        public jsonresult getbyid(string id)
        {
            var tt = _context.set<user>().where(c => c.id == id).tolist();
            //_context.set<user>().add(us);
            //_context.savechanges();
            return json(tt);
        }
        /// <summary>
        /// 添加
        /// </summary>
        /// <param name="entity"></param>
        /// <returns></returns>
        [httppost]
        public jsonresult add(user entity = null)
        {
            _context.set<user>().add(entity);
            int num = _context.savechanges();

            if (entity == null)
                return json("参数为空");
            if (num > 0) { return json("成功"); }
            else { return json("失敗"); }
        }
        /// <summary>
        /// 编辑 
        /// </summary>
        /// <param name="entity"></param>
        /// <returns></returns>
        [httpput]
        [route("user")]
        public jsonresult update(user entity = null)
        {

            _context.set<user>().update(entity);
            int num = _context.savechanges();
            if (entity == null)
                return json("参数为空");
            if (num > 0) { return json("成功"); }
            else { return json("失敗"); }
        }

        /// <summary>
        /// 删除 
        /// </summary>
        /// <param name="ids"></param>
        /// <returns></returns>
        [httpdelete]
        public jsonresult dels(string ids = null)
        {
            if (ids.length == 0)
                return json("参数为空");
            var tt = _context.set<user>().where(c => c.id == ids).first();
            _context.set<user>().remove(tt);
            int num = _context.savechanges();
            if (num > 0) { return json("成功"); }
            else { return json("失敗"); }
        }
        #endregion
    }
}

view code

自此一个简单的api基本完成，需要运行检验还需要一个步骤。

3】swagger

为了检测接口运行，这里选择swagger

首先在api层通过nuget引用swashbuckle.aspnetcore

 

然后右键单击core.api项目选择属性，打开一个新面板之后选择左侧的生成菜单=》扎到输出提示。选择输出路径bin\debug\netcoreapp2.1\=》勾选xml文档文件

然后回到 startup.cs ，分别加入以下代码 

 此处需要先在nuget中引用 microsoft.extensions.platformabstractions

注意 上文中生成的core.api.xml写入到下列方法中 ，名字要保持一致，否者报错

     #region swagger
            services.addswaggergen(c =>
            {
                c.swaggerdoc("v1", new info
                {
                    version = "v1.1.0",
                    title = "ray webapi",
                    description = "框架集合",
                    termsofservice = "none",
                    contact = new swashbuckle.aspnetcore.swagger.contact { name = "raywang", email = "[e-mail]", url = "http://www.cnblogs.com/raywang" }
                });
                //添加读取注释服务  nuget  microsoft.extensions.platformabstractions
                var basepath = platformservices.default.application.applicationbasepath;
                var xmlpath = path.combine(basepath, "core.api.xml");//此处为生成xml文档
                c.includexmlcomments(xmlpath);
               
            });
            #endregion

view code

 

 

  #region swagger
            app.useswagger();
            app.useswaggerui(c =>
            {
                c.swaggerendpoint("/swagger/v1/swagger.json", "apihelp v1");
            });
            #endregion

view code

，最后来到launchsettings.json修改以下代码，将api/value修改为swagger，表示项目已启动就显示swagger的主页面，而不用通过输入路劲

 

因为本项目是codefirst，所以最后在项目启动之前别忘记在nuget控制台运行以下两行代码

先输入：add-migration  myfirstmigration(名字。这里随意取未myfirstmigration)
 在输入：update-database  

补充一个小问题，博主首次在nuget控制台输入

add-migration  myfirstmigration的时候不知道为什么报错，后来先输入add-migration  然后随意取一个名字才成功。之前未遇见过。如果遇到此类错误的读者可以先试试我这个办法。

 

 

最后】最后运行代码，就会看到页面如下

添加一条数据进行尝试，单击绿色post=》单击try it out =》输入数据（这里我全部输入“测试”）=》单击execute

然后鼠标下滑，就可以看到返回的结果

然后进入数据库验证，发现数据插入成功