使用Swashbuckle.AspNetCore.SwaggerGen 生成 ASP.NET Core2 WebAPI 在线文档

最新推荐文章于 2023-09-12 14:19:49 发布

baykermr

最新推荐文章于 2023-09-12 14:19:49 发布

阅读量3.8k

点赞数

分类专栏： ASP.NET Core2 WebAPI 文章标签： ASP.NET Core2 WebAPI Swagger

本文链接：https://blog.csdn.net/Baykermr/article/details/81089210

版权

在我们开发WebAPI 时通常需要为调用我们API的客户端提供说明文档。Swager 就是这样的一个工具，它能生成漂亮的API文档和提供在线调用的页面。

Swashbuckle.AspNetCore 中分为3个组件，我们可以使用其中一个或多个。

Package	Description
Swashbuckle.AspNetCore.Swagger	Exposes SwaggerDocument objects as a JSON API. It expects an implementation of ISwaggerProvider to be registered which it queries to retrieve Swagger document(s) before returning as serialized JSON
Swashbuckle.AspNetCore.SwaggerGen	Injects an implementation of ISwaggerProvider that can be used by the above component. This particular implementation automatically generates SwaggerDocument(s) from your routes, controllers and models
Swashbuckle.AspNetCore.SwaggerUI	Exposes an embedded version of the swagger-ui. You specify the API endpoints where it can obtain Swagger JSON and it uses them to power interactive docs for your API

本文使用Swashbuckle.AspNetCore.SwaggerGen 3.0 版本来生成API文档。

关注