- 确认阿里云代理商账号权限及身份认证。
- 登录阿里云管理控制台，选择产品“API管理”。
- 进入API管理页面，在左侧导航栏中选择“我的API”。
- 在“我的API”页面左侧菜单栏中选择“文档中心”。
- 在“文档中心”页面中选择“API文档编辑”。
- 创建并编辑API文档，包括基本信息、请求参数、返回参数、错误码等。
- 可使用“预览”功能查看API文档效果。
- 保存并发布API文档。
- 可使用“生成SDK”功能生成SDK软件包，方便第三方开发者使用。
可以使用Swagger或OpenAPI来生成API文档。以下是使用Swagger生成文档的步骤：
- 在项目的pom.xml中添加Swagger依赖：
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>- 创建一个Swagger配置类：
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}- 在Controller中添加Swagger注解：
@RestController
@Api(tags = "用户管理")
public class UserController {
@ApiOperation("获取用户列表")
@GetMapping("/users")
public List<User> getUsers() {
// TODO: 返回用户列表
}
@ApiOperation("创建用户")
@PostMapping("/users")
public void createUser(@RequestBody User user) {
// TODO: 创建用户
}
@ApiOperation("更新用户")
@PutMapping("/users/{id}")
public void updateUser(@PathVariable Long id, @RequestBody User user) {
// TODO: 更新用户
}
@ApiOperation("删除用户")
@DeleteMapping("/users/{id}")
public void deleteUser(@PathVariable Long id) {
// TODO: 删除用户
}
}- 启动应用程序并访问 http://localhost:8080/swagger-ui.html ，即可看到生成的API文档。
发布者：luotuoemo，转转请注明出处：https://www.jintuiyun.com/159760.html
