荥经县 东乡县 永德县 灵丘县 克什克腾旗 米林县 泸西县 青川县 新津县 万盛区 郸城县 土默特左旗 平安县 黄梅县 北京市 桐柏县
时间:2019-05-21 10:44:53 来源:绿野 作者:2018年最新新闻网 点击:9264
薛平贵与王宝钏

尸鬼_.NET Core和Swagger 生成 Api 文档

标签:蔬菜生产 苏州市

前言

最近写了好多Web api, 老大说太乱了,要整理一下,使用Swagger。
花了半天的时间,在这里记录和分享一些过程和遇到的问题。

遇到的主要问题:
1.localhost:9040/swagger/ not found

2.http://localhost:9040/swagger界面可以打开,但是can"t read json file.

1.引用

这里引用了三个库,都是在Nuget上安装:
1.Microsoft.AspNetCore.StaticFiles, Version="2.0.3" , 这个package提供UI显示相关服务
2.Swashbuckle.AspNetCore, Version="2.4.0"
3.Swashbuckle.AspNetCore.SwaggerUi, Version="2.4.0"

2.打开startup.cs文件

using Swashbuckle.AspNetCore.Swagger;

在ConfigureServices集合中注入AddSwaggerGen:

public void ConfigureServices(IServiceCollection services)
{
        services.AddMvc();            

        // Enable CORS
        services.AddCors();

        //Inject Swagger 
        services.AddSwaggerGen(c =>
        {天狼星_2018年最新新闻网
            c.SwaggerDoc("v1", new Info { Title = "MyApi", Version = "v1" });
            // Set the comments path for the Swagger JSON and UI.
            var xmlPath = Path.Combine(AppContext.BaseDirectory, "ChatBotApi.XML");
            c.IncludeXmlComments(xmlPath);
        });
}

在Configure中启用中间件,允许Swagger提供服务生成json文档以及UI:

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
        }

       学校2013_2018年最新新闻网 app.UseMvc(routes =>
        {
            routes.MapRoute(
                name: "default",
         我的英雄学院_2018年最新新闻网       template: "{controller}/{action=Index}/{id?}");
        });

        app.UseStaticFiles();

        // Enable middleware to serve generated Swagger as a JSON endpoint.
        app.UseSwagger(c => { c.RouteTemplate = "swagger/{documentName}/swagger.json"; });

        // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), 
        /智慧树_2018年最新新闻网/ specifying the Swagger JSON endpoint.
        app.UseSwaggerUI(c =>
        {
            //c.RoutePrefix = "swagge

3.设置XML注释

在 Visual Studio 中右击项目并且选择 Properties 在 Output Settings 区域下面点击 XML Documentation file 。

这时候编译项目,会出现很多warning,提示api没有注释,在每个Api controller上方,连续输入三个"/",即可将api的对应信息补充完整,要给每个Api route加上 http的请求方式。
在各个Api里加上注释:

/// <summary>
/// Put value by id and value
/// </summary>
/// <param name="id">id</param>
/// <param name="value">value</param>
/// PUT api/values/5
[HttpPut("{id}")]
public void Put(int id, [FromBody]string value)
{
}
        

4.运行结果

1.在浏览器中输入:http://localhost:/swagger/v1/swagger.json

返回Json文档:

用json viewer打开json文件:

2.在浏览器输入:http://localhost:9040/swagger/

到此说明配置Swagger成功。

详细的API列表和文档说明:

5.主要问题的解决办法

1.RoutePrefix
这是个坑,要好好匹配当前的项目路径,不然UI打不开

2.SwaggerEndpoint
这是个坑,也是一样,如果路径匹配错误,UI打开了但是读取json文档失败。

这两个路径配置可以多试几神印王座_2018年最新新闻网次,我尝试了几十次~~

6.可以自定义UI

这个暂时没有做,今天太晚了,占个位置~

参考文档

1.Get started with Swashbuckle and ASP.NET Core
2.Swagger .NETCORE can"t read json
3.ASP.NET Core 中文文档

当前文章:http://whm3w7-gouzaoyu-com.zhaistockbroker.cn/hgzggq17/f2c26_157398.html

发布时间:2019-05-21 01:45:17

澳门银河送彩金  澳门银河官网yh163am.com  澳门银河手机网站福建霞浦渔船失事致1人失联  澳门银河官网yh163am.com  澳门银河送彩金雷军香港见李嘉诚 长和与小米达成合作  澳门银河送彩金俄罗斯红场5月4日至9日将关闭参观  澳门银河yh7788.bet  银河娱乐首页yh163am.com  919银河优越会  澳门银河娱乐送彩金网站  

本文标签: 官居一品 蒙古国谴责美国 全运会

回到顶部