在本教程中,我们将展示如何使用Swagger注解使我们的文档更加描述性。首先,我们将学习如何为API的不同部分添加描述,比如方法、参数和错误代码。然后我们将看到如何添加请求/响应示例。
2. 项目设置
我们将创建一个简单的产品API,提供创建和获取产品的方法。
从头开始创建REST API,我们可以按照Spring Docs的这个教程使用Spring Boot创建RESTful web服务。
接下来将是为项目设置依赖项和配置。我们可以按照本文的步骤为Spring REST API设置Swagger 2。
3. 创建API
大约 5 分钟