首先,我们认识了openApi接口规范,为了解决接口不统一的问题
然后学习了swagger实现了openApi的工具集
java中的使用
首先引入依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency>
使用
首先要配置
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .host("localhost:8089") .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.leyou.order.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("乐优商城订单系统") .description("乐优商城订单系统接口文档") .version("1.0") .build(); } }
第一个注释@Api,修饰类,描述controller的作用
@Api("订单服务接口") public class OrderController {
第二个注释,@ApiOperation描述一个类的一个方法 ,@ApiImplicitparm描述单个参数
/** * 创建订单 * * @param order 订单