zoukankan      html  css  js  c++  java
  • asp.net core Api配置swagger

    这个很简单的一篇文章用来记录以下使用swagger的过程,以后有用。

    1.nuget 下载install-package Swashbuckle.AspNetCore

    2.startup里面configureservice配置:

     services.AddSwaggerGen(c =>
                {
                    //添加document,这个主要用来在swaggerUI页面上面显示一些额外的信息
                    //注意第一个参数"pangjianxin"这个参数要和startup中configure方法中的
                    //c.SwaggerEndpoint("/swagger/pangjianxin/swagger.json", "My API V1");保持一致,否则swagger会报错。
                    c.SwaggerDoc("pangjianxin", new Info
                    {
    
                        Version = "v12",
                        Title = "api列表",
                        Description = "一个简单的api列表",
                        TermsOfService = "None",
                        Contact = new Contact
                        {
                            Name = "庞建新",
                            Email = "343516704@qq.com",
                            Url = "https://www.baidu.com"
                        },
                        License = new License
                        {
                            Name = "no license",
                            Url = "https://www.baidu.com"
                        }
                    });
                    //添加读取controller中action注释的作用,但是要首先在项目属性==》生成==》勾选XML选项,并记住名字,在这里用。
                    var basePath = PlatformServices.Default.Application.ApplicationBasePath;
                    var xmlPath = Path.Combine(basePath, "Api.xml");
                    c.IncludeXmlComments(xmlPath);
                });
    

    3.在startup中configure配置:

                 //在添加swagger并将其作为json端点配置到中间件管道上
                app.UseSwagger();
    
                //配置swaggerUI的中间件,并指定上述配置的json端点
                app.UseSwaggerUI(c =>
                {
    //配置swagger的json端点 c.SwaggerEndpoint("/swagger/pangjianxin/swagger.json", "My API V1"); //RoutePrefix,路由前缀,赋值strig.Empty说明点击网站根目录就可以进入swaggerUI c.RoutePrefix = string.Empty; });

     然后就没有然后了 

  • 相关阅读:
    持续集成环境搭建(一)
    The POSIX API/nss/nscd
    [postfix]转发邮件设置
    [python]python安装包错误
    栈及栈帧讲解
    kernel-init-bash
    nginx no input file specified
    Lumen/Laravel调试API接口利器laravel-debugbar
    homestead实现外部局域网络其他主机的访问
    PHP rabbitmq扩展安装
  • 原文地址:https://www.cnblogs.com/pangjianxin/p/9268534.html
Copyright © 2011-2022 走看看