10分钟带你进入Swagger的世界,快来看一看吧

我们非常重视原创文章,为尊重知识产权并避免潜在的版权问题,我们在此提供文章的摘要供您初步了解。如果您想要查阅更为详尽的内容,访问作者的公众号页面获取完整文章。

什么是Swagger?
Swagger是一套强大且易用的API开发工具集,适合个人和团队使用,覆盖API生命周期的各个阶段,包括设计、文档、测试和部署。它由多种开源、免费和商业工具组成,适用于不同角色的用户,由SmartBear Software构建,这家公司是软件质量工具的领导者。
在NET Core API中使用swagger
1. 创建net core api项目
以ASP.NET Core 3.1创建名为swaggerDemo的WebAPI接口项目。
2. 引入swagger中间件
在nuget中添加名为Swashbuckle.AspNetCore的swagger中间件。
3. 配置swagger中间件
在Startup.cs文件的ConfigureServices方法中添加代码以添加API文档的元数据,还要添加代码以包括控制器层的注释。
4. 创建一个api接口控制器
创建Home控制器,并定义多个方法进行测试。
5. 设置显示注释
在swaggerDemo项目属性的生成选项中勾选XML文档文件,并在ConfigureServices方法中通过代码添加控制器层注释。
6. swagger展示
运行项目并将浏览器地址栏中的路径更改为swagger/index.html来查看swagger的搭建结果。
7. swagger如何调试接口
在swagger UI中选择需要调试的接口,点击Try it out进行编辑,输入参数后点击Execute来发送请求并查看服务器响应。
总结
Swagger的应用不仅限于基础操作,而日常开发中已足够使用。选择合适的工具是关键,熟练掌握一个即可。具体问题需要具体分析,根据需求添加新功能。
原文作者:熊泽-学习中的苦与乐,公众号:熊泽有话说。
想要了解更多内容?



白皮书上线