天峻县 靖远县 碌曲县 古交市 沽源县 湖北省 蛟河市 广平县 衡南县 石泉县 延寿县 洛南县 合阳县 汽车 肃南 彩票
国内2018年最新新闻网主页 > 2018年最新新闻网国内 >
摘要:ss小燕之夜...

唐砖_.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 =>
        {
            c.SwaggerDoc("v1", new Info { Title = "MyAp

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

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExcepti学园默示录_2018年最新新闻网
        }

        app.北戴河_2018年最新新闻网UseMvc(routes =>
        {
            routes.MapRoute(
                name: "default",
                template: "{controller}/{action=Index}/{id?}");
        });

        app.UseStaticFiles();

        // Enable middleware to serve generated Swagger as a JSON endpoint.
      nba中国赛_2018年最新新闻网  app.UseSwagger(c => { c.RouteTemplate = "swagger/{documentName}/swagger.json"; });

        // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), 
        // specifying the Swagger JSON endpoint.
        app.UseSwaggerUI(c =>
        {
            //c.RoutePrefix = "swagger/ui";
            c.SwaggerEndpoint("v1/swagger.json", "ChatBotApi");
        });
}

3.设置XML注释

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

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

/// <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文档失败。

这两个路径配置可以多试几次,我尝试了几十次~~

6.可以自定义UI

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

参考文档

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

当前文章:http://www-chulimo-com.ke5kqe.tw/qbo5gv/87352_156812.html

发布时间:2019-07-17 02:14:09

919银河优越会千斤小龙虾翻车 遭过往车辆碾压成  澳门银河yh99.com  澳门银河真人在线娱乐  银河娱乐在线官方网址  澳门银河有正规平台吗  银河娱乐手机官网  澳门银河官网真人娱乐  银河娱乐在线官方网址  www.7163.com澳门银河  澳门银河娱乐yh163am.com  

?