queyue-backend
/
luoo_parent
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

1.add swagger for music

Browse Source
main
Gary 11 months ago
parent 800381c290
commit a7856e4f84
9 changed files with 136 additions and 161 deletions
Show Stats Download Patch File Download Diff File

54
luoo_common/pom.xml
Unescape View File

@ -1,23 +1,33 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <project xmlns="http://maven.apache.org/POM/4.0.0"
<modelVersion>4.0.0</modelVersion> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<parent> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<groupId>com.luoo</groupId> <modelVersion>4.0.0</modelVersion>
<artifactId>luoo_parent</artifactId> <parent>
<version>1.0-SNAPSHOT</version> <groupId>com.luoo</groupId>
</parent> <artifactId>luoo_parent</artifactId>
<artifactId>luoo_common</artifactId> <version>1.0-SNAPSHOT</version>
<dependencies> </parent>
<dependency> <artifactId>luoo_common</artifactId>
<groupId>io.jsonwebtoken</groupId> <dependencies>
<artifactId>jjwt</artifactId> <dependency>
<version>0.9.1</version> <groupId>io.jsonwebtoken</groupId>
</dependency> <artifactId>jjwt</artifactId>
<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 --> <version>0.9.1</version>
<dependency> </dependency>
<groupId>org.apache.commons</groupId> <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
<artifactId>commons-lang3</artifactId> <dependency>
<version>3.14.0</version> <groupId>org.apache.commons</groupId>
</dependency> <artifactId>commons-lang3</artifactId>
<version>3.14.0</version>
</dependencies> </dependency>
<!--swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
</dependency>
</dependencies>
</project> </project>

27
luoo_music/src/main/java/com/luoo/music/MusicApplication.java
Unescape View File

@ -1,11 +1,19 @@
package com.luoo.music; package com.luoo.music;
import java.net.InetAddress;
import java.net.UnknownHostException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication; import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching; import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient; import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient; import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients; import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.core.env.Environment;
import util.IdWorker; import util.IdWorker;
@SpringBootApplication @SpringBootApplication
@EnableEurekaClient @EnableEurekaClient
@ -13,9 +21,22 @@ import util.IdWorker;
@EnableFeignClients @EnableFeignClients
@EnableCaching @EnableCaching
public class MusicApplication { public class MusicApplication {
static Logger logger= LoggerFactory.getLogger(MusicApplication.class);
public static void main(String[] args) { public static void main(String[] args) throws UnknownHostException {
SpringApplication.run(MusicApplication.class, args); ConfigurableApplicationContext application=SpringApplication.run(MusicApplication.class, args);
Environment env = application.getEnvironment();
logger.info("\n----------------------------------------------------------\n\t" +
"Application '{}' is running! Access URLs:\n\t" +
"Local: \t\thttp://localhost:{}\n\t" +
"External: \thttp://{}:{}\n\t"+
"Doc: \thttp://{}:{}/doc.html\n"+
"----------------------------------------------------------",
env.getProperty("spring.application.name"),
env.getProperty("server.port"),
InetAddress.getLocalHost().getHostAddress(),
env.getProperty("server.port"),
InetAddress.getLocalHost().getHostAddress(),
env.getProperty("server.port"));
} }
@Bean @Bean

27
luoo_music/src/main/java/com/luoo/music/config/SwaggerConfig.java
Unescape View File

@ -0,0 +1,27 @@
package com.luoo.music.config;
import org.springframework.context.annotation.Configuration;
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import swagger.BaseSwaggerConfig;
import swagger.SwaggerProperties;
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfig extends BaseSwaggerConfig {
@Override
public SwaggerProperties swaggerProperties() {
return SwaggerProperties.builder()
.apiBasePackage("com.luoo.music.controller")
.title("luoo-music API")
.description("luoo-music 后端接口文档")
.contactName("locust")
.version("1.0")
.enableSecurity(false)
.build();
}
}

15
luoo_music/src/main/java/com/luoo/music/config/WebMvcConfig.java
Unescape View File

@ -0,0 +1,15 @@
package com.luoo.music.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
super.addResourceHandlers(registry);
}
}

11
luoo_user/pom.xml
Unescape View File

@ -61,17 +61,6 @@
<artifactId>lombok</artifactId> <artifactId>lombok</artifactId>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
<!--swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.3</version>
</dependency>
<dependency> <dependency>
<groupId>com.apifan.common</groupId> <groupId>com.apifan.common</groupId>
<artifactId>common-random</artifactId> <artifactId>common-random</artifactId>

4
luoo_user/src/main/java/com/luoo/user/swagger/SwaggerConfig.java → luoo_user/src/main/java/com/luoo/user/config/SwaggerConfig.java
Unescape View File

@ -1,10 +1,12 @@
package com.luoo.user.swagger; package com.luoo.user.config;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI; import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import springfox.documentation.swagger2.annotations.EnableSwagger2; import springfox.documentation.swagger2.annotations.EnableSwagger2;
import swagger.BaseSwaggerConfig;
import swagger.SwaggerProperties;
@Configuration @Configuration
@EnableSwagger2 @EnableSwagger2

58
luoo_user/src/main/java/com/luoo/user/swagger/BaseSwaggerConfig.java
Unescape View File

@ -1,58 +0,0 @@
package com.luoo.user.swagger;
import org.springframework.context.annotation.Bean;
import org.springframework.core.annotation.Order;
import org.springframework.web.bind.annotation.RequestMethod;
import io.swagger.annotations.ApiOperation;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.builders.ResponseMessageBuilder;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import java.util.ArrayList;
import java.util.List;
public abstract class BaseSwaggerConfig {
@Bean
@Order(value = 1)
public Docket createRestApi() {
List<ResponseMessage> responseMessageList =new ArrayList<>();
responseMessageList.add(new ResponseMessageBuilder().code(200).message("成功").responseModel(new ModelRef("成功")).build());
responseMessageList.add(new ResponseMessageBuilder().code(20001).message("失败").responseModel(new ModelRef("失败")).build());
responseMessageList.add(new ResponseMessageBuilder().code(20002).message("用户名或密码错误").responseModel(new ModelRef("用户名或密码错误")).build());
responseMessageList.add(new ResponseMessageBuilder().code(20003).message("无权访问").responseModel(new ModelRef("无权访问")).build());
responseMessageList.add(new ResponseMessageBuilder().code(20009).message("重复提交").responseModel(new ModelRef("重复提交")).build());
SwaggerProperties swaggerProperties = swaggerProperties();
return new Docket(DocumentationType.SWAGGER_2)
.globalResponseMessage(RequestMethod.GET, responseMessageList)
.globalResponseMessage(RequestMethod.POST, responseMessageList)
.globalResponseMessage(RequestMethod.PUT, responseMessageList)
.globalResponseMessage(RequestMethod.DELETE, responseMessageList)
.apiInfo(apiInfo(swaggerProperties))
.select()
.apis(RequestHandlerSelectors.basePackage(swaggerProperties.getApiBasePackage()))
//.apis(RequestHandlerSelectors.withClassAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo(SwaggerProperties swaggerProperties) {
return new ApiInfoBuilder()
.title(swaggerProperties.getTitle())
.description(swaggerProperties.getDescription())
.contact(new Contact(swaggerProperties.getContactName(), swaggerProperties.getContactUrl(), swaggerProperties.getContactEmail()))
.version(swaggerProperties.getVersion())
.build();
}
/**
* 自定义Swagger配置
*/
public abstract SwaggerProperties swaggerProperties();
}

47
luoo_user/src/main/java/com/luoo/user/swagger/SwaggerProperties.java
Unescape View File

@ -1,47 +0,0 @@
package com.luoo.user.swagger;
import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
/**
* Swagger自定义配置
* Created by macro on 2020/7/16.
*/
@Data
@EqualsAndHashCode(callSuper = false)
@Builder
public class SwaggerProperties {
/**
* API文档生成基础路径
*/
private String apiBasePackage;
/**
* 是否要启用登录认证
*/
private boolean enableSecurity;
/**
* 文档标题
*/
private String title;
/**
* 文档描述
*/
private String description;
/**
* 文档版本
*/
private String version;
/**
* 文档联系人姓名
*/
private String contactName;
/**
* 文档联系人网址
*/
private String contactUrl;
/**
* 文档联系人邮箱
*/
private String contactEmail;
}

54
pom.xml
Unescape View File

@ -1,40 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<groupId>com.luoo</groupId> <groupId>com.luoo</groupId>
<artifactId>luoo_parent</artifactId> <artifactId>luoo_parent</artifactId>
<version>1.0-SNAPSHOT</version> <version>1.0-SNAPSHOT</version>
<modules> <modules>
<module>luoo_common</module> <module>luoo_common</module>
<module>luoo_recruit</module> <module>luoo_recruit</module>
<module>luoo_user</module> <module>luoo_user</module>
<module>luoo_music</module> <module>luoo_music</module>
<module>luoo_gathering</module> <module>luoo_gathering</module>
<module>luoo_comment</module> <module>luoo_comment</module>
<module>luoo_eureka</module> <module>luoo_eureka</module>
<module>luoo_friend</module> <module>luoo_friend</module>
<module>luoo_manage</module> <module>luoo_manage</module>
<module>luoo_web</module> <module>luoo_web</module>
<module>luoo_sms</module> <module>luoo_sms</module>
<module>luoo_config</module> <module>luoo_config</module>
<module>luoo_tag</module> <module>luoo_tag</module>
</modules> </modules>
<packaging>pom</packaging> <packaging>pom</packaging>
<name>luoo_parent</name> <name>luoo_parent</name>
<parent> <parent>
<groupId>org.springframework.boot</groupId> <groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId> <artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.1.RELEASE</version> <version>2.0.1.RELEASE</version>
<relativePath/> <relativePath />
</parent> </parent>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version> <java.version>1.8</java.version>
<springfox-swagger2.version>2.8.0</springfox-swagger2.version>
<swagger-bootstrap-ui.version>1.9.3</swagger-bootstrap-ui.version>
</properties> </properties>
<dependencyManagement> <dependencyManagement>
@ -46,6 +49,17 @@
<type>pom</type> <type>pom</type>
<scope>import</scope> <scope>import</scope>
</dependency> </dependency>
<!--swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox-swagger2.version}</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>${swagger-bootstrap-ui.version}</version>
</dependency>
</dependencies> </dependencies>
</dependencyManagement> </dependencyManagement>
@ -64,11 +78,13 @@
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId> <artifactId>spring-cloud-starter-config</artifactId>
</dependency> </dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies> </dependencies>
<repositories> <repositories>
<repository> <repository>
<id>spring-snapshots</id> <id>spring-snapshots</id>

Write Preview
Loading…
Cancel
Save