zoukankan      html  css  js  c++  java
  • 如何使用Swagger生成API文档

    1 Swagger是什么?

    Swagger用于描述 REST API。 它允许计算机和人员了解服务的功能,而无需直接访问实现(源代码、网络访问、文档)。

    2 安装

    Swashbuckle.AspNetCore
    

    添加Swagger生成器

    将Swagger生成器添加到 Startup.ConfigureServices 方法中的服务集合中:

    services.AddSwaggerGen();
    

    配置Swagger中间件

    在 Startup.Configure 方法中,启用中间件为生成的 JSON 文档和 Swagger UI 提供服务:

    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    });
    

    XML注释

    • 在“解决方案资源管理器”中右键单击该项目,然后选择“编辑< project_name>.csproj” 。
    • 手动将PropertyGroup添加:
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    

    更改services.AddSwaggerGen();代码如下:

    services.AddSwaggerGen((c =>
    {
        var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
        var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
        c.IncludeXmlComments(xmlPath);
    }));
    

    效果

  • 相关阅读:
    node.js
    重学css
    MongoDB
    改写radio样式
    js系统总结
    vue+koa2商城实战学习笔记
    在Linux上配置unixODBC和FreeTDS访问MS SQL Server
    ASP.NET中文件上传下载方法集合
    SQL SERVER 分页查询存储过程
    Delphi7调用C#写的Webservice
  • 原文地址:https://www.cnblogs.com/zcqiand/p/14258075.html
Copyright © 2011-2022 走看看