使用io.swagger.v3生成代码文档

使用io.swagger.v3生成代码文档

访问路径：http://localhost:8091/swagger-ui/index.html
扫描OpenApiConfiguration

代码

import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author huangJunHao
 * @date 2022/3/23
 */
@Configuration
public class OpenApiConfiguration {

    @Bean
    public GroupedOpenApi loginGroupedOpenApi() {
        return GroupedOpenApi.builder()
        		#改成模块对应的分区
                .group("login")
                #改成要生成文档的controller层
                .packagesToScan("com.watsons.onstore.user.web")
                .build();
    }
}

常用注解

控制器

#用于类，说明类的作用
@Tag(name = "LoginController", description = "登录模块")
#用于方法，说明方法的作用
@Operation(summary = "登录接口")
#用于接收的参数，说明参数的作用
@Parameter(description = "账号")