Asp.NetCore 中使用Swagger

Swagger又被成为openapi,是用来生成API的帮助文档的,废话不多说,直接说配置

  1. 安装
install-package swashbuckle.AspNetCore
  1. 配置Startup.cs
    在ConfigureServices里添加如下code
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "API",
                    Version = "V1"
                });
            });

在configure里添加如下code

app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1");
            });
  1. 运行程序
    访问https://localhost:44344/swagger/v1/swagger.json 看的是json
    访问https://localhost:44344/swagger 看到的是UI

  2. 假如某个controller的action不想被展示,则通过设置ApiExplorerSettings特性,将其IgnoreApi属性设置为true

[HttpGet("{id}")]
[ApiExplorerSettings(IgnoreApi =true)]
public Author Details(Guid id)
{
     return _dataAccessProvider.GetPatientSingleRecord(id);
}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值