swagger ui demo

前言

  前幾天一個朋友公司在用Springboot集合swagger時候老是從瀏覽器看不了接口,我兩找了問題,可是他仍是沒有找到,因而我就本身從http://start.spring.io/上下載了一個demo,而後作一個swagger小集成,這個應該很簡單的。本身嘗試了一下,而後作個總,具體也就這三步。以後的業務,本身再結合本身公司項目一步一步加上去,可能一開始的demo是簡單的,可是首先要保證第一步沒問題了,以後有問題,那就說明是以後加的東西出了問題。html

正文

  第一步:項目引入jar包路徑,我用的是gradle項目。spring

      compile 'io.springfox:springfox-swagger2:2.7.0'
      compile 'io.springfox:springfox-swagger-ui:2.7.0'
api

     第二步:啓動項中須要initApi的方法這個是必要的。感受東西就這些,話不用說太多,見代碼。瀏覽器

      @EnableSwagger2
      @SpringBootApplication
      public class DemoApplication {

        public static void main(String[] args) {
          SpringApplication.run(DemoApplication.class, args);
        }
        @Bean
        public Docket initApi() {
          return new Docket(DocumentationType.SWAGGER_2)
             .enable(true)
             .apiInfo(demoApiInfo())
             .select()
             .apis(RequestHandlerSelectors.any())
             .build();
        }

        private ApiInfo demoApiInfo() {
          Contact contact = new Contact("xxx", "http://xxx", "xxxx");
          return new ApiInfoBuilder()
             .title("測試API")
            .description("REST風格API")
            .termsOfServiceUrl("http:xxx.xx.com")
            .contact(contact)
            .version("1.0")
            .build();
       }
    }
app

  第三步:就是咱們要寫一個controller也就是api的地方。測試

      @RestController
      @RequestMapping(path = "/test")
      @Api(tags = {"test"})
      public class TestController {
        @GetMapping
        @ApiOperation(value = "測試")
        public String test() {
          return "testok";
         }
      }
gradle

  以後就能夠啓動咱們的項目了,經過8080/swagger-ui.html訪問咱們的接口地址,這樣就完成了。ui

  

 

 

 

                  Believe that life is getting better

相關文章
相關標籤/搜索