swagger2 学习案例

SpringBoot + Swagger2 UI界面

本文介绍一个非常好用的自动化生成 Restful API 文档的工具——Swagger2

1.导入依赖–spingboot+swagger2

<!-- swagger RESTful API文档-->
<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.7.0.RELEASE</version>
</dependency>

2.swagger文档配置

EnableSwagger2
@Configuration
public class seagger2  extends WebMvcConfigurationSupport {
    @Bean
    public Docket creteRestApi(){
        ApiInfo apiInfo=new ApiInfoBuilder()
                .title("api项目接口文档")
                .description("符合Restfuk api")
                .version("1.0")
                .build();
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                //以扫描的方式
                .apis(RequestHandlerSelectors  
                //扫描路径更还包的位置
                .basePackage("com.jstorm.count.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**")
                .addResourceLocations("classpath:/static/");
        registry.addResourceHandler("/js/**")
                .addResourceLocations("classpath:/js/");
        registry
                .addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry
                .addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

3.controller层给Restful Api 注解添加注释

Alt text
Alt text

4.spingboot启动入口添加注解

@SpringBootApplication
@EnableWebMvc

5.效果

Alt text


 上一篇
inno setup学习入门 inno setup学习入门
Inno Setup是什么? Inno Setup 是一个免费的 Windows 安装程序制作软件。第一次发表是在 1997 年。话不多说,开整 组件相关文本框/编辑框 编辑框也叫文本框,是典型的窗口可视化组件,既可以用来输入文本,也可以
2019-03-12
下一篇 
java进阶路线图 java进阶路线图
一:架构师审美观 学习Java技术体系,设计模式,流行的框架与组件,常见的设计模式,编码必备,Spring5,做应用必不可少的最新框架,MyBatis,玩数据库必不可少的组件…… 二:DevOps(架构师工具箱) 工欲善其事必先利其器
2019-02-25
  目录