SwaggerUI自动生成API文档(SwaggerUI+SpringBoot)

最新推荐文章于 2024-05-11 14:17:48 发布
最新推荐文章于 2024-05-11 14:17:48 发布
阅读量2w 收藏 5
点赞数 2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhe1110/article/details/53005290
版权


SwaggerUI+SpringBoot

测试 访问地址  http://localhost:8080/v1/swagger-ui.html#/
下面是具体配置

Maven依赖 
   
   

    
    

     
      <!-- Swagger -->
    
    

    
    

     
      <dependency>
    
    

    
    

     
      <groupId>io.springfox</groupId>
    
    

    
    

     
      <artifactId>springfox-swagger-ui</artifactId>
    
    

    
    

     
      <version>2.2.2</version>
    
    

    
    

     
      </dependency>
    
    

    
    

     
      <dependency>
    
    

    
    

     
      <groupId>io.springfox</groupId>
    
    

    
    

     
      <artifactId>springfox-swagger2</artifactId>
    
    

    
    

     
      <version>2.2.2</version>
    
    

    
    

     
      </dependency>
    
    

    
    

     
      <!-- END Swagger -->

properties 
   
   

    
    

     
     server.servlet-path=/v1

Config 
   
   

    
    

     
     package com.unioncast.db.config;
    
    

    
    

     
      
    
    

    
    

     
     import static com.google.common.base.Predicates.or;
    
    

    
    

     
     import static springfox.documentation.builders.PathSelectors.regex;
    
    

    
    

     
      
    
    

    
    

     
     import org.springframework.beans.factory.annotation.Value;
    
    

    
    

     
     import org.springframework.context.annotation.Bean;
    
    

    
    

     
     import org.springframework.context.annotation.Configuration;
    
    

    
    

     
     import org.springframework.http.ResponseEntity;
    
    

    
    

     
      
    
    

    
    

     
     import com.google.common.base.Predicate;
    
    

    
    

     
     import com.google.common.base.Predicates;
    
    

    
    

     
      
    
    

    
    

     
     import springfox.documentation.builders.PathSelectors;
    
    

    
    

     
     import springfox.documentation.service.ApiInfo;
    
    

    
    

     
     import springfox.documentation.spi.DocumentationType;
    
    

    
    

     
     import springfox.documentation.spring.web.plugins.Docket;
    
    

    
    

     
      
    
    

    
    

     
     /**
    
    

    
    

     
      * SwaggerConfig
    
    

    
    

     
      */
    
    

    
    

     
     @Configuration
    
    

    
    

     
     public class SwaggerConfig {
    
    

    
    

     
      
    
    

    
    

     
      @Value("${server.servlet-path}")
    
    

    
    

     
      private String pathMapping;
    
    

    
    

     
      
    
    

    
    

     
      private ApiInfo initApiInfo() {
    
    

    
    

     
      ApiInfo apiInfo = new ApiInfo("数据存储项目 Platform API", // 大标题
    
    

    
    

     
      initContextInfo(), // 简单的描述
    
    

    
    

     
      "1.0.0", // 版本
    
    

    
    

     
      "服务条款", "后台开发团队", // 作者
    
    

    
    

     
      "The Apache License, Version 2.0", // 链接显示文字
    
    

    
    

     
      "http://www.baidu.com"// 网站链接
    
    

    
    

     
      );
    
    

    
    

     
      return apiInfo;
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      private String initContextInfo() {
    
    

    
    

     
      StringBuffer sb = new StringBuffer();
    
    

    
    

     
      sb.append("REST API 设计在细节上有很多自己独特的需要注意的技巧，并且对开发人员在构架设计能力上比传统 API 有着更高的要求。").append("<br/>")
    
    

    
    

     
      .append("以下是本项目的API文档");
    
    

    
    

     
      return sb.toString();
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      @Bean
    
    

    
    

     
      public Docket restfulApi() {
    
    

    
    

     
      System.out.println("http://localhost:8080" + pathMapping + "/swagger-ui.html");
    
    

    
    

     
      return new Docket(DocumentationType.SWAGGER_2).groupName("RestfulApi")
    
    

    
    

     
      // .genericModelSubstitutes(DeferredResult.class)
    
    

    
    

     
      .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(true).forCodeGeneration(false)
    
    

    
    

     
      .pathMapping(pathMapping) // base，最终调用接口后会和paths拼接在一起
    
    

    
    

     
      .select().paths(doFilteringRules()).build().apiInfo(initApiInfo());
    
    

    
    

     
      // .select().paths(Predicates.not(PathSelectors.regex("/error.*"))).build().apiInfo(initApiInfo());
    
    

    
    

     
      
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 设置过滤规则 这里的过滤规则支持正则匹配    //若有静态方法在此之前加载就会报集合相关的错误.
    
    

    
    

     
      * 
    
    

    
    

     
      * @return
    
    

    
    

     
      */
    
    

    
    

     
      private Predicate<String> doFilteringRules() {
    
    

    
    

     
     // return Predicates.not(PathSelectors.regex("/error.*"));
    
    

    
    

     
     // return or(regex("/hello.*"), regex("/rest/adxSspFinanceManagement.*"));//success
    
    

    
    

     
      return or(regex("/hello.*"), regex("/rest.*"));
    
    

    
    

     
      }
    
    

    
    

     
     }

run 
   
   

    
    

     
     package com.unioncast.db;
    
    

    
    

     
      
    
    

    
    

     
     import org.springframework.boot.SpringApplication;
    
    

    
    

     
     import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    

    
    

     
      
    
    

    
    

     
     import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    

    
    

     
      
    
    

    
    

     
     @SpringBootApplication
    
    

    
    

     
     @EnableSwagger2
    
    

    
    

     
     public class DbRestApiApplication {
    
    

    
    

     
      
    
    

    
    

     
     // private static final Logger LOG = LogManager.getLogger(DbRestApiApplication.class);
    
    

    
    

     
      
    
    

    
    

     
      public static void main(String[] args) {
    
    

    
    

     
      SpringApplication.run(DbRestApiApplication.class, args);
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
     // @Bean
    
    

    
    

     
     // public WebMvcConfigurerAdapter adapter() {
    
    

    
    

     
     // return new WebMvcConfigurerAdapter() {
    
    

    
    

     
     // @Override
    
    

    
    

     
     // public void addInterceptors(InterceptorRegistry registry) {
    
    

    
    

     
     // super.addInterceptors(registry);
    
    

    
    

     
     // registry.addInterceptor(new HandlerInterceptor() {
    
    

    
    

     
     // @Override
    
    

    
    

     
     // public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    
    

    
    

     
     // throws Exception {
    
    

    
    

     
     // // TODO 计划把controller里那些日志转移到这里进行输出
    
    

    
    

     
     // LOG.info("preHandle");
    
    

    
    

     
     // return true;
    
    

    
    

     
     // }
    
    

    
    

     
     //
    
    

    
    

     
     // @Override
    
    

    
    

     
     // public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
    
    

    
    

     
     // ModelAndView modelAndView) throws Exception {
    
    

    
    

     
     // LOG.info("postHandle");
    
    

    
    

     
     // }
    
    

    
    

     
     //
    
    

    
    

     
     // @Override
    
    

    
    

     
     // public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
    
    

    
    

     
     // Object handler, Exception ex) throws Exception {
    
    

    
    

     
     // LOG.info("afterCompletion");
    
    

    
    

     
     // }
    
    

    
    

     
     // }).addPathPatterns("/**");
    
    

    
    

     
     // }
    
    

    
    

     
     // };
    
    

    
    

     
     // }
    
    

    
    

     
      
    
    

    
    

     
      
    
    

    
    

     
     }


case
 
   
   

    
    

     
     package com.unioncast.db.api.rest.adx;
    
    

    
    

     
      
    
    

    
    

     
     import java.net.URI;
    
    

    
    

     
     import java.util.List;
    
    

    
    

     
      
    
    

    
    

     
     import org.slf4j.Logger;
    
    

    
    

     
     import org.slf4j.LoggerFactory;
    
    

    
    

     
     import org.springframework.beans.factory.annotation.Autowired;
    
    

    
    

     
     import org.springframework.http.HttpHeaders;
    
    

    
    

     
     import org.springframework.http.HttpStatus;
    
    

    
    

     
     import org.springframework.http.ResponseEntity;
    
    

    
    

     
     import org.springframework.web.bind.annotation.PathVariable;
    
    

    
    

     
     import org.springframework.web.bind.annotation.RequestBody;
    
    

    
    

     
     import org.springframework.web.bind.annotation.RequestMapping;
    
    

    
    

     
     import org.springframework.web.bind.annotation.RequestMethod;
    
    

    
    

     
     import org.springframework.web.bind.annotation.ResponseStatus;
    
    

    
    

     
     import org.springframework.web.bind.annotation.RestController;
    
    

    
    

     
     import org.springframework.web.util.UriComponentsBuilder;
    
    

    
    

     
      
    
    

    
    

     
     import com.unioncast.common.adx.model.AdxSspFinanceManagement;
    
    

    
    

     
     import com.unioncast.common.page.Pagination;
    
    

    
    

     
     import com.unioncast.common.restClient.RestResponse;
    
    

    
    

     
     import com.unioncast.db.api.rest.GeneralController;
    
    

    
    

     
     import com.unioncast.db.rdbms.core.exception.DaoException;
    
    

    
    

     
     import com.unioncast.db.rdbms.core.service.adxDBService.AdxSspFinanceManagementService;
    
    

    
    

     
      
    
    

    
    

     
     import io.swagger.annotations.Api;
    
    

    
    

     
     import io.swagger.annotations.ApiImplicitParam;
    
    

    
    

     
     import io.swagger.annotations.ApiImplicitParams;
    
    

    
    

     
     import io.swagger.annotations.ApiOperation;
    
    

    
    

     
      
    
    

    
    

     
     @Api(value = "API - AdxSspFinanceManagementController")
    
    

    
    

     
     @RestController
    
    

    
    

     
     @RequestMapping("/rest/adxSspFinanceManagement")
    
    

    
    

     
     public class AdxSspFinanceManagementController extends GeneralController {
    
    

    
    

     
      
    
    

    
    

     
      private static final Logger LOG = LoggerFactory.getLogger(AdxSspFinanceManagementController.class);
    
    

    
    

     
      
    
    

    
    

     
      @Autowired
    
    

    
    

     
      private AdxSspFinanceManagementService adxSspFinanceManagementService;
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 查找所有
    
    

    
    

     
      * 
    
    

    
    

     
      * @date 2016年10月19日 下午1:30:29
    
    

    
    

     
      *
    
    

    
    

     
      * @return
    
    

    
    

     
      * @throws DaoException
    
    

    
    

     
      */
    
    

    
    

     
      @ApiOperation(value = "查找所有", httpMethod = "POST", response = RestResponse.class)
    
    

    
    

     
      @RequestMapping(value = "/findAll", method = RequestMethod.POST)
    
    

    
    

     
      public RestResponse findAll() throws DaoException {
    
    

    
    

     
      RestResponse restResponse = new RestResponse();
    
    

    
    

     
      restResponse.setStatus(RestResponse.OK);
    
    

    
    

     
      AdxSspFinanceManagement[] adxSspFinanceManagements = adxSspFinanceManagementService.findAll();
    
    

    
    

     
      LOG.info("adxSspFinanceManagements:{}", (Object) adxSspFinanceManagements);
    
    

    
    

     
      restResponse.setResult(adxSspFinanceManagementService.findAll());
    
    

    
    

     
      return restResponse;
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 分页条件查找
    
    

    
    

     
      *
    
    

    
    

     
      * @date 2016年9月29日 下午6:59:46
    
    

    
    

     
      *
    
    

    
    

     
      * @return
    
    

    
    

     
      * @throws DaoException
    
    

    
    

     
      */
    
    

    
    

     
      @ApiOperation(value = "分页条件查找", httpMethod = "POST", response = RestResponse.class)
    
    

    
    

     
      @ApiImplicitParams({
    
    

    
    

     
      @ApiImplicitParam(name = "currentPage", required = true, dataType = "Integer", paramType = "path"),
    
    

    
    

     
      @ApiImplicitParam(name = "pageSize", required = true, dataType = "Integer", paramType = "path"),
    
    

    
    

     
      @ApiImplicitParam(name = "adxSspFinanceManagement", required = true, dataType = "AdxSspFinanceManagement", paramType = "body") })
    
    

    
    

     
      @RequestMapping(value = "/page/{currentPage}/{pageSize}", method = RequestMethod.POST)
    
    

    
    

     
      public RestResponse page(@RequestBody AdxSspFinanceManagement adxSspFinanceManagement,
    
    

    
    

     
      @PathVariable Integer currentPage, @PathVariable Integer pageSize) throws DaoException {
    
    

    
    

     
      LOG.info("adxSspFinanceManagementCondition:{}", adxSspFinanceManagement);
    
    

    
    

     
      LOG.info("currentPage:{}", currentPage);
    
    

    
    

     
      LOG.info("pageSize:{}", pageSize);
    
    

    
    

     
      RestResponse restResponse = new RestResponse();
    
    

    
    

     
      restResponse.setStatus(RestResponse.OK);
    
    

    
    

     
      Pagination<AdxSspFinanceManagement> pagination = adxSspFinanceManagementService.page(adxSspFinanceManagement,
    
    

    
    

     
      currentPage, pageSize);
    
    

    
    

     
      LOG.info("pagination:{}", pagination);
    
    

    
    

     
      restResponse.setResult(adxSspFinanceManagementService.page(adxSspFinanceManagement, currentPage, pageSize));
    
    

    
    

     
      return restResponse;
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 根据id查找
    
    

    
    

     
      *
    
    

    
    

     
      * @date 2016年9月29日 下午7:09:03
    
    

    
    

     
      *
    
    

    
    

     
      * @param id
    
    

    
    

     
      * @return
    
    

    
    

     
      * @throws DaoException
    
    

    
    

     
      */
    
    

    
    

     
      @ApiOperation(value = "根据id查找", httpMethod = "POST", response = RestResponse.class)
    
    

    
    

     
      @ApiImplicitParams({ @ApiImplicitParam(name = "id", required = true, dataType = "Integer", paramType = "path") })
    
    

    
    

     
      @RequestMapping(value = "/findById/{id}", method = RequestMethod.POST)
    
    

    
    

     
      public RestResponse findById(@PathVariable Long id) throws DaoException {
    
    

    
    

     
      LOG.info("id:{}", id);
    
    

    
    

     
      RestResponse restResponse = new RestResponse();
    
    

    
    

     
      restResponse.setStatus(RestResponse.OK);
    
    

    
    

     
      AdxSspFinanceManagement adxSspFinanceManagement = adxSspFinanceManagementService.findById(id);
    
    

    
    

     
      LOG.info("adxSspFinanceManagement:{}", adxSspFinanceManagement);
    
    

    
    

     
      restResponse.setResult(adxSspFinanceManagementService.findById(id));
    
    

    
    

     
      return restResponse;
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 增加
    
    

    
    

     
      * 
    
    

    
    

     
      * @date 2016年10月21日 下午5:02:59
    
    

    
    

     
      *
    
    

    
    

     
      * @param adxSspFinanceManagement
    
    

    
    

     
      * @param uriComponentsBuilder
    
    

    
    

     
      * @return
    
    

    
    

     
      * @throws DaoException
    
    

    
    

     
      */
    
    

    
    

     
      @ApiOperation(value = "增加", httpMethod = "POST", response = RestResponse.class)
    
    

    
    

     
      @ApiImplicitParams({
    
    

    
    

     
      @ApiImplicitParam(name = "adxSspFinanceManagement", required = true, dataType = "AdxSspFinanceManagement", paramType = "body") })
    
    

    
    

     
      @RequestMapping(value = "/add", method = RequestMethod.POST)
    
    

    
    

     
      public ResponseEntity<RestResponse> add(@RequestBody AdxSspFinanceManagement adxSspFinanceManagement,
    
    

    
    

     
      UriComponentsBuilder uriComponentsBuilder) throws DaoException {
    
    

    
    

     
      LOG.info("adxSspFinanceManagement:{}", adxSspFinanceManagement);
    
    

    
    

     
      RestResponse restResponse = new RestResponse();
    
    

    
    

     
      restResponse.setStatus(RestResponse.OK);
    
    

    
    

     
      Long id = adxSspFinanceManagementService.save(adxSspFinanceManagement);
    
    

    
    

     
      LOG.info("id:{}", id);
    
    

    
    

     
      restResponse.setResult(id);
    
    

    
    

     
      HttpHeaders httpHeaders = new HttpHeaders();
    
    

    
    

     
      URI uri = uriComponentsBuilder.path("/rest/adxSspFinanceManagement/findById/").path(String.valueOf(id)).build()
    
    

    
    

     
      .toUri();
    
    

    
    

     
      httpHeaders.setLocation(uri);
    
    

    
    

     
      return new ResponseEntity<RestResponse>(restResponse, httpHeaders, HttpStatus.CREATED);
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 批量增加
    
    

    
    

     
      * 
    
    

    
    

     
      * @date 2016年10月21日 下午5:02:47
    
    

    
    

     
      *
    
    

    
    

     
      * @param adxSspFinanceManagements
    
    

    
    

     
      * @return
    
    

    
    

     
      * @throws DaoException
    
    

    
    

     
      */
    
    

    
    

     
      @ApiOperation(value = "批量增加", httpMethod = "POST", response = RestResponse.class)
    
    

    
    

     
      @ApiImplicitParams({
    
    

    
    

     
      @ApiImplicitParam(name = "adxSspFinanceManagements", required = true, dataType = "List<AdxSspFinanceManagement>", paramType = "body") })
    
    

    
    

     
      @RequestMapping(value = "/batchAdd", method = RequestMethod.POST)
    
    

    
    

     
      @ResponseStatus(HttpStatus.CREATED)
    
    

    
    

     
      public RestResponse batchAdd(@RequestBody List<AdxSspFinanceManagement> adxSspFinanceManagements)
    
    

    
    

     
      throws DaoException {
    
    

    
    

     
      RestResponse restResponse = new RestResponse();
    
    

    
    

     
      restResponse.setStatus(RestResponse.OK);
    
    

    
    

     
      List<Long> ids = adxSspFinanceManagementService.batchAdd(adxSspFinanceManagements);
    
    

    
    

     
      LOG.info("ids:{}", ids);
    
    

    
    

     
      restResponse.setResult(ids);
    
    

    
    

     
      return restResponse;
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 修改
    
    

    
    

     
      * 
    
    

    
    

     
      * @date 2016年10月21日 下午5:03:38
    
    

    
    

     
      *
    
    

    
    

     
      * @param adxSspFinanceManagement
    
    

    
    

     
      * @throws DaoException
    
    

    
    

     
      */
    
    

    
    

     
      @ApiOperation(value = "修改", httpMethod = "POST", response = RestResponse.class)
    
    

    
    

     
      @ApiImplicitParams({
    
    

    
    

     
      @ApiImplicitParam(name = "adxSspFinanceManagement", required = true, dataType = "AdxSspFinanceManagement", paramType = "body") })
    
    

    
    

     
      @RequestMapping(value = "/update", method = RequestMethod.POST)
    
    

    
    

     
      public void update(@RequestBody AdxSspFinanceManagement adxSspFinanceManagement) throws DaoException {
    
    

    
    

     
      LOG.info("adxSspFinanceManagement:{}", adxSspFinanceManagement);
    
    

    
    

     
      adxSspFinanceManagementService.updateNotNullField(adxSspFinanceManagement);
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 删除
    
    

    
    

     
      *
    
    

    
    

     
      * @date 2016年9月29日 下午7:27:57
    
    

    
    

     
      *
    
    

    
    

     
      * @param id
    
    

    
    

     
      * @return 删除了多少条
    
    

    
    

     
      * @throws DaoException
    
    

    
    

     
      */
    
    

    
    

     
      @ApiOperation(value = "删除", httpMethod = "POST", response = RestResponse.class)
    
    

    
    

     
      @ApiImplicitParams({ @ApiImplicitParam(name = "id", required = true, dataType = "Long", paramType = "path") })
    
    

    
    

     
      @RequestMapping(value = "/delete/{id}", method = RequestMethod.POST)
    
    

    
    

     
      public RestResponse delete(@PathVariable Long id) throws DaoException {
    
    

    
    

     
      RestResponse restResponse = new RestResponse();
    
    

    
    

     
      restResponse.setStatus(RestResponse.OK);
    
    

    
    

     
      int i = adxSspFinanceManagementService.deleteById(id);
    
    

    
    

     
      LOG.info("the number of delete:{}", i);
    
    

    
    

     
      restResponse.setResult(i);
    
    

    
    

     
      return restResponse;
    
    

    
    

     
      }
    
    

    
    

     
      
    
    

    
    

     
      /**
    
    

    
    

     
      * 批量删除
    
    

    
    

     
      *
    
    

    
    

     
      * @date 2016年9月29日 下午7:29:22
    
    

    
    

     
      *
    
    

    
    

     
      * @param id
    
    

    
    

     
      * @return 删除了多少条
    
    

    
    

     
      * @throws DaoException
    
    

    
    

     
      */
    
    

    
    

     
      @ApiOperation(value = "删除", httpMethod = "POST", response = RestResponse.class)
    
    

    
    

     
      @ApiImplicitParams({ @ApiImplicitParam(name = "id", required = true, dataType = "Long", paramType = "path") })
    
    

    
    

     
      @RequestMapping(value = "/batchDelete", method = RequestMethod.POST)
    
    

    
    

     
      public RestResponse batchDelete(@RequestBody List<Long> ids) throws DaoException {
    
    

    
    

     
      RestResponse restResponse = new RestResponse();
    
    

    
    

     
      int i = adxSspFinanceManagementService.batchDelete(ids);
    
    

    
    

     
      restResponse.setStatus(RestResponse.OK);
    
    

    
    

     
      restResponse.setResult(i);
    
    

    
    

     
      LOG.info("the number of delete:{}", i);
    
    

    
    

     
      return restResponse;
    
    

    
    

     
      }
    
    

    
    

     
     }


zhe1110
关注
  • 2
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
简单易懂：使用 Swagger 自动生成 API 文档
2301_78234743的博客
01-24 942
深圳市新凯来（深圳国资委全资公司）招聘开始了，招聘硬件工程师，包括数字，射频，互连，工艺，热，结构等方向，校招和社招同步开启，有意向同学可以私我，也可以推荐给周。vivo白菜(都可以查到），加班这个不用想是肯定的网传中行985 第一年18，第四年能涨到32，但是也看到很多降薪，32的饼吃不到的消息都在深圳，纠结的点在于，坐标中科云谷，缺后端，部门加班少，项目赶得紧的话会有些加班，但双休基本上都有，且平时加班可以调休，周末加班双倍工资。我之前觉得一个公司好，后面又会觉得不好，人的想法是回时刻变的。
使用swagger自动生成文档
树洞树洞-单纯记录
07-04 271
pom.xml <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2...
软件测试学习笔记丨Spring Boot结合 Swagger 生成 API
最新发布
Tester_muller的博客
05-11 776
/ 页面标题.title("spring-test系统")// 描述.description("spring-test-lp 接口文档")// 创建人信息// 项目API版本号.build();@Bean//Swagger 的配置主要围绕Docket bean 进行：//配置是否启用Swagger，如果是false，在浏览器将无法访问，默认是true。
使用Swagger自动生成API说明文档
12-14
一份关于使用Swagger自动生成API说明文档的开发文档。
Swagger2--自动生成接口文档工具学习
rain67的博客
08-28 1981
在swagger2版本中，需要使用swagger2，并可以从浏览器中ui渲染，必须导入两个依赖 （这里放的是使用人数最多的依赖版本）
Swagger 自动生成 Api 文档教程，超详细！
LiamHong_的博客
07-26 816
Tapir是一个开源的 API 设计和文档工具，它基于OpenAPI 规范（也称为 Swagger 规范）并提供了更高级别的抽象，可以帮助开发人员更轻松地设计和文档化。Tapir 以可视化的方式显示 API 的不同端点和参数，并提供了丰富的编辑功能和自动化的 API 文档生成工具，可以生成易于阅读和理解的文档，同时也提供了多种导出格式（如 OpenAPI 规范、Markdown 等）以满足不同需求。
SpringBoot＋Swagger-ui自动生成API文档
08-26
今天小编就为大家分享一篇关于SpringBoot＋Swagger-ui自动生成API文档，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
SpringBoot结合Swagger2自动生成api文档的方法
08-26
SpringBoot 结合 Swagger2 自动生成 API 文档的方法 在软件开发中，文档的重要性不言而喻。好的文档不仅能够帮助开发者更好地理解代码，还能够提高项目的可读性和可维护性。本文将介绍如何使用 SpringBoot 结合 ...
springboot+swagger-ui+PageHelper分页+logback+动态定时
06-24
通过以上技术的集成，我们可以构建一个功能完善的后端服务，提供清晰的API文档，支持数据库查询的分页，记录详细的日志，以及允许用户根据需求动态调整定时任务。这极大地提高了项目的可维护性和用户体验。
springboot+myabtis+maven+swagger
08-31
Swagger通过`@Api`, `@ApiOperation`, `@ApiParam`等注解，将接口的元数据与代码关联，自动生成API文档，方便前后端协作和API的版本控制。 在这个项目中，开发人员可能已经将Spring Boot与MyBatis集成，实现了...
springboot+druid+redis+swagger+security
01-28
它通过注解来描述API接口，可以自动生成API文档，帮助开发者更好地理解和使用API。Swagger UI可以让用户在浏览器中直接测试API，提升开发效率。 5. **Spring Security**：Spring Security是Spring生态中的一个强大...
Swqgger ui和Spring Boot集成时需要的静态资源
02-04
本文件解压后会有一个public 文件夹，包含css 文件夹和images文件夹。当Swagger ui和Spring Boot集成，并用Maven管理项目的时候，把public 文件夹放到 src/main/resources 下面。
Swagger编写API文档的YAML示例
02-14
通过Swagger Editor,使用yaml编写的API接口文档，导入到Swagger Editor即可看到效果．
超详细！使用swagger自动生成Api文档（swagger-ui）
热门推荐
zhanggonglalala的博客
08-01 12万+
介绍 swagger是什么？ swagger-ui 使用swagger-ui 简单使用 swagger api注解 本文参考： 介绍 这里是一些介绍，如果想直接看如何使用，请直接跳过这部分。但如果有时间，就姑且看一下吧，这部分大概用时3分钟。 swagger是什么？ Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口...
如何利用Swagger-UI自动生成接口文档？
ouyangsong的博客
07-30 475
一、常用注解 Swagger-UI是HTML, Javascript, CSS的一个集合，可以动态地根据注解生成在线API文档 @Api：用于修饰Controller类，生成Controller相关文档信息 @ApiOperation：用于修饰Controller类中的方法，生成接口方法相关文档信息 @ApiModel：用于修饰接口中的参数，生成接口参数相关文档信息 @ApiModelProperty：用于修饰实体类的属性，当实体类是请求参数或返回结果时，直接生成相关文档信息 二、 添加依赖 <!
Springboot集成Swagger2（成功率最高的教程！）
待到春花烂漫时
11-24 1万+
废话不多说，四步走： 1.添加maven依赖 <!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version&g
在spring-boot中使用Swagger
超人不会飞
06-28 477
在spring-boot中使用Swagger配置1.需要依赖两个包：&lt;dependency&gt;&lt;groupId&gt;io.springfox&lt;/groupId&gt;&lt;artifactId&gt;springfox-swagger2&lt;/artifactId&gt;&lt;version&gt;${springfox-version}&lt;/version&gt
SpringBoot实战之一swagger
akenseren的博客
10-04 484
本文简要对swagger进行了介绍，并介绍了如何在springboot项目中集成swagger，swagger是优秀的api文档工具，对于它的其他使用后续在使用中进一步补充。
springboot集成swagger
健康平安的活着的专栏
03-11 332
一.swagger介绍 1.1 概述 目前互联网时代前后端分离已成趋势，前后端混在一起，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发。解决方案就是前后端通过API进行交互达到相对独立且松耦合。 Swagger就是这样的一个API框架，Swagger支持多种语言 如：Java，PHP等，它号称是世界上最流行的API框架！ swagger是一个方便后端编写接口文档的开源项目，并提供界面化测试。 1.2 swagger界面组成 Swagger实例Bean是Docket，所以必
swagger + springboot
05-31
结合使用Swagger和Spring Boot可以快速构建RESTful API，并且方便地生成API文档以及进行在线API测试。 在Spring Boot中集成Swagger需要引入相应的Swagger依赖，并且在配置类中使用@EnableSwagger2注解开启Swagger...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值