精选:swagger-ui

   本篇文章给大家谈谈swagger-ui,以及对应的知识点,希望对各位有所帮助,不要忘了收藏本站喔。

  提问一:使用nutz做rest接口开发,怎样与swagger-ui集成

  贡献用户名:【一梦浮鱼】 ,现在由百学百科小编为你探讨与【swagger-ui】的相关内容!

  贡献者回答1. 引入pom依赖(springMVC配置可用)

  <dependency>

  <groupId>io.springfox</groupId>

  <artifactId>springfox-swagger2</artifactId>

  <version>2.5.0</version>

  </dependency>

  <dependency>

  <groupId>io.springfox</groupId>

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

  <version>2.5.0</version>

  </dependency>

  2.配置bean

  @EnableSwagger2

  public class SwaggerConfig {

  @Bean

  public Docket createRestApi() {

  return new Docket(DocumentationType.SWAGGER_2)

  .apiInfo(apiInfo())

  .select()

  .apis(RequestHandlerSelectors.basePackage("your base package"))

  .paths(PathSelectors.any())

  .build();

  }

  private ApiInfo apiInfo() {

  return new ApiInfoBuilder()

  .title("xxxapi接口文档(所有编码为utf8)")

  .version("1.0")

  .description("api 文档描述")

  .build();

  }

  }

  3.注册配置bean(放在springMVC的配置文件中)

  <bean class="mypackage.swagger.config.SwaggerConfig"></bean>

  4.编写接口注释

  @RestController

  @RequestMapping(value = "/login")

  @Api(description = "登陆页面")

  public class AppLoginController {

  @Autowired

  private ILoginService loginService;

  @ApiOperation(value = "用户密码登陆")

  @ApiImplicitParams({

  @ApiImplicitParam(name = "mobile", value = "手机号", required = true, dataType = "String", paramType = "query", defaultValue = "13000000000"),

  @ApiImplicitParam(name = "password", value = "密码", required = true, dataType = "String", paramType = "query", defaultValue = "123456") })

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

  public AjaxResult login(String mobile, String password) {

  . login .

  }

  5.访问rest接口

  项目根路径/v2/api-docs swageer根据接口生成的json文件,可以自定义UI来实现接口文档

  项目根路径/swagger-ui.html 访问swagger-ui的rest接口界面,访问必须通过springMVC的DispatchServlet

  希望可以帮到你 望

  以上就是百学百科小编分享贡献者:(一梦浮鱼)回答的关于“使用nutz做rest接口开发,怎样与swagger-ui集成”的问题了,不知是否已经解决你的问题?如果没有,下一篇内容可能是你想要的答案,接下来继续分析下文用户【一笑动君心】贡献的“如何在SpringBoot里使用SwaggerUI”的一些相关疑点做出分析与解答,如果能找到你的答案,可以关注本站。

  提问二:如何在SpringBoot里使用SwaggerUI

  本文贡献者:【一笑动君心】 ,解答(swagger-ui)的问题,如果问题解决,可以关注本站!

  贡献者回答SpringBoot嵌入SwaggerUI

  步骤

  1.jar包引入

  <dependency>

  <groupId>io.springfox</groupId>

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

  <version>2.2.2</version>

  <scope>compile</scope>

  </dependency>

  <dependency>

  <groupId>io.springfox</groupId>

  <artifactId>springfox-swagger2</artifactId>

  <version>2.2.2</version>

  <scope>compile</scope>

  </dependency>

  2.基于SpringBoot配置SwaggerConfig

  @Configuration

  @EnableSwagger2

  public class SwaggerConfig {

  @Bean

  public Docket newsApi() {

  //return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().paths(PathSelectors.any()).build();

  Docket docket = new Docket(DocumentationType.SWAGGER_2);

  docket.enable(true);

  docket.apiInfo(apiInfo()).select().paths(PathSelectors.any()).build();

  return docket;

  }

  private ApiInfo apiInfo() {

  return new ApiInfoBuilder().title("订单中心测试平台").description("在这里你可以浏览项目所有接口,并提供相关测试工具")

  .termsOfServiceUrl("software/sla/sladb.nsf/sla/bmOpen").contact("test")

  .license("China Red Star Licence Version 1.0").licenseUrl("#").version("1.0").build();

  }

  }

  3.WebConfig配置说明

  这里有一个需要注意的问题,让WebConfig去继承WebMvcAutoConfigurationAdapter而不是直接继承WebMvcConfigurerAdapter,否则Swagger的页面出不来。

  @Configuration

  @EnableWebMvc

  public class WebConfig extends WebMvcAutoConfigurationAdapter {

  @Override

  public void addCorsMappings(CorsRegistry registry) {

  registry.addMapping("/**");

  }

  @Bean

  public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {

  return new PropertySourcesPlaceholderConfigurer();

  }

  @Bean

  public Filter characterEncodingFilter() {

  CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();

  characterEncodingFilter.setEncoding("UTF-8");

  characterEncodingFilter.setForceEncoding(true);

  return characterEncodingFilter;

  }

  @Bean

  public MappingJackson2HttpMessageConverter converter() {

  MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();

  return converter;

  }

  上文就是百学百科小编分享贡献者:(一笑动君心)解答的关于“如何在SpringBoot里使用SwaggerUI”的问题了,不知是否已经解决你的问题?如果没有,下一篇内容可能是你想要的答案,现在接着继续热议下文用户【花落丶爲誰】分享的“spring boot整合swagger时,打开swagger-ui中文出现乱码”的一些相关疑问做出分析与解答,如果能找到你的答案,可以关注本站。

  提问三:spring boot整合swagger时,打开swagger-ui中文出现乱码

  本文贡献者:【花落丶爲誰】, 疑问关键字:swagger-ui, 下面就让百学百科小编为你解答,希望本文能找到您要的答案!

  贡献者回答问题记录:

  本例采用的swagger版本及相关组件

  问题出现原因:

  加入了Shiro后就出现了乱码,可能是在加入Shiro的时候编码选择错了,网上介绍的办法大多是在setting设置以及对tomcat的设置,但是还是不得,在先不探讨Shiro倒置的情况下,找到了如下的解决办法

  在config类中,继承自WebMvcConfigurationSupport类,重写以下方法:

  注意:不要直接在swagger配置类直接继承WebMvcConfigurationSupport,不然会出现

  No mapping for GET /swagger-ui.html 的报错

  今天的内容先分享到这里了,读完本文《精选:swagger-ui》之后,是否是您想找的答案呢?想要了解更多,敬请关注baike.100xue.net,您的关注是给小编最大的鼓励。

版权声明:本文内容转载自网络,该文观点仅代表作者本人。登载此文出于传递更多信息之目的,并不意味着赞同其观点或证实其描述。文章内容仅供参考,不构成投资建议。如发现本站有涉嫌抄袭侵权/违法违规的内容,请联系本站举报,一经查实,本站将立刻删除。