zoukankan      html  css  js  c++  java
  • Asp.net WebApi 生成SwaggerUI文档

    我们为什么需要文档

       好的文档能够让前后端开发沟通更轻松

    Swagger ui 文档的优点 

        可在线测试的,方便前后端调试

    使用步骤

    1.  新建WebApi 项目
    2. Nuget 引入相应的类库 Install-Package Swashbuckle (swaggerui 2.0)
    3. 引入之后,会在App_Start 目录生成 SwaggerConfig.cs 文件
    4. 修改 SwaggerConfig.cs 文件 c.IncludeXmlComments 函数,引入需要包含的 xml 文件(c# summary 注释会自动生成xml文件)
    5. 多个项目需要引入多个xml文件
    6. 修改每个项目对应的属性-》build-》输出-》勾选 xml文档文件
    7. 启动项目 访问  xxx:xx/swagger 就能看到自动生成文档了,对应json,可以查看swaggerui 头部输入框里的 连接

    常见错误

       1  直接访问加载不出来文档,如果使用json.net的序列化,需要设置 NullHanding 为 ignore  

       

    settings.NullValueHandling = NullValueHandling.Ignore;
    

      

      2 如果生成的复杂参数没有正确解析为对象,请检查是否设置了 json.net 驼峰 返回

  • 相关阅读:
    QT解析和组装json
    linux下磁盘存储空间不足
    linux下的QT打包方法
    linux下编译protobuf
    linux下编译opencv
    linux下的qt串口通信
    QT执行shell脚本及linux指令相关
    windows下QT打包
    启动zookeeper却没有进程
    Linux命令
  • 原文地址:https://www.cnblogs.com/blueker-li/p/7243230.html
Copyright © 2011-2022 走看看