首页 > 其他分享 >Swagger接口文档描述显示注释内容

Swagger接口文档描述显示注释内容

时间:2023-03-21 16:33:05浏览次数:34  
标签:接口 v1 文档 FirstPropertiesBackendAPI Swagger config

一、Swagger接口文档描述显示注释内容

 

 

 ①右击项目属性=>生成=>输出

 

 

 ②Swagger配置

services.AddSwaggerGen(config =>
            {
                #region 配置API文档说明
                config.SwaggerDoc("v1", new OpenApiInfo
                {
                    Version = "v1",
                    Title = "FirstPropertiesBackendAPI",
                    Description = "接口文档",
                    Contact = new OpenApiContact
                    {
                        Name = "Name",
                        Email = "test"
                    }
                });

                var basePath = AppContext.BaseDirectory;
                var xmlPath = Path.Combine(basePath, "FirstPropertiesBackendAPI.xml");
                config.IncludeXmlComments(xmlPath, true);
                #endregion
            });

 

                app.UseSwagger();
                app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "FirstPropertiesBackendAPI v1"));

 

标签:接口,v1,文档,FirstPropertiesBackendAPI,Swagger,config
From: https://www.cnblogs.com/jf-ace/p/17240456.html

相关文章

  • 多态之接口类
    用接口,可以让学生继承2个类,接口是一种规范,一种能力,一种扩展usingSystem;namespace多态之接口类{classProgram{staticvoidMain(string[]ar......
  • 【python】多线程并发,rpc接口性能测试
    1、官方文档https://docs.python.org/3/library/concurrent.futures.html 2、安装python3.x中自带了concurrent.futures模块python2.7需要安装futures模块,使用命令......
  • 通过appId和appSecret生成accessToken访问api后端接口(接口授权)
    功能点(1)申请获取appId和appSecret(2)通过appId和appSecret获取accessToken(3)mysql和redis进行key-value键值对存储(4)对需要的接口url进行请求地址拦截效果图:(1)正确的accessToken......
  • 获取项目中调用的其他接口列表
    packagespringcloud_producer_8001;importjava.io.File;importjava.io.FileReader;importjava.io.FileWriter;importjava.io.OutputStream;importjava.lang.reflect.M......
  • Java 接口的所有子类都需要执行相同处理逻辑的推荐姿势
    一、背景在实际开发过程中,有些时候我们可能会遇到这样的场景:我们定义接口给上游使用,不同的业务类型定义不同的子类型,实现该接口的某个函数,但是这些子类型会有很多公共的逻辑......
  • Solon2 接口开发: 实战 Gateway 模式效果
    1、效果预览网关@Mapping("/api/v3/app/**")@ComponentpublicclassApiGateway3xextendsUapiGateway{@Overrideprotectedvoidregister(){fi......
  • 分析document文档中script标签获取抖音无水印视频
    思路分析使用playwright模拟浏览器打开分享链接获取播放页面html信息解析播放页面的video标签,video标签的src属性就是视频的地址这种模式会触发抖音的风控机......
  • 使用token机制实现接口幂等性校验
    大家好,我是小悟问题和概念1、接口调用存在的问题现如今我们的系统大多拆分为分布式SOA,或者微服务,一套系统中包含了多个子系统服务,而一个子系统服务往往会去调用另一个服务,而......
  • ckeditor粘贴word文档图片的组件
    由于工作需要必须将word文档内容粘贴到编辑器中使用但发现word中的图片粘贴后变成了file:///xxxx.jpg这种内容,如果上传到服务器后其他人也访问不了,网上找了很多编辑器发现......
  • swagger-ui-react 前端引用草稿
    前言SwaggerUI是一个React组件,它接受一个配置对象作为其唯一的属性。这个配置对象可以包含多个属性来自定义SwaggerUI的行为和外观。以下是SwaggerUI支持的主要属性及其说......