关键技术接口根据name查询功能

pom.xml

@@ -23,10 +23,20 @@
     </profiles>
     <properties>
         <java.version>1.8</java.version>
+        <swagger.version>2.9.2</swagger.version>
     </properties>
 
     <dependencies>
-
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>${swagger.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>${swagger.version}</version>
+        </dependency>
 
         <dependency>
             <groupId>org.eclipse.jgit</groupId>

src/main/java/com/zjty/inspect/config/Swagger2Configuration.java

+package com.zjty.inspect.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+//
+@Configuration
+@EnableSwagger2
+public class Swagger2Configuration {
+    @Bean
+    public Docket createRestApi() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .apiInfo(apiInfo())
+                .select()
+                .apis(RequestHandlerSelectors.basePackage("com.zjty.inspect"))
+                .paths(PathSelectors.any())
+                .build();
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title("评估api文档")
+                .description("评估api文档")
+//                .termsOfServiceUrl("/")
+                .version("1.0")
+                .build();
+    }
+
+}

src/main/java/com/zjty/inspect/controller/InspectController.java

@@ -7,6 +7,8 @@ import com.zjty.inspect.utils.FileUtil;
 import com.zjty.inspect.utils.GitLabUtil;
 import com.zjty.inspect.utils.MavenUtil;
 import com.zjty.inspect.utils.UUIDUtil;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.apache.commons.io.FileUtils;
 import org.apache.tomcat.util.http.fileupload.disk.DiskFileItem;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -24,6 +26,7 @@ import java.io.*;
  */
 @RestController
 @RequestMapping("/inspect")
+@Api(value = "cms页面管理接口",description = "cms页面管理接口,提供页面的增、删、改、查")
 public class InspectController {
     @Autowired
     private InspectService inspectService;
@@ -39,6 +42,7 @@ public class InspectController {
      * @throws IOException
      */
     @PostMapping("/path")
+    @ApiOperation("上传代码进行评估")
     public ResponseEntity inspect(Integer years,Integer systemFund,Integer modules
             ,String valid,Double framework,Double safety,Double disaster,Integer data
             ,Integer admin, MultipartFile multfile) throws IOException {
@@ -69,6 +73,7 @@ public class InspectController {
      * @return
      */
     @PostMapping("/git")
+    @ApiOperation("git下载代码进行评估")
     public ResponseEntity inspect1(@RequestBody InspectParameter inspectParameter){
         String path = GitLabUtil.downLoadProject(inspectParameter.getGitAddress(),inspectParameter.getGitName());
         inspectParameter.setId(UUIDUtil.getUUID());
@@ -79,6 +84,7 @@ public class InspectController {
     }
 
     @PostMapping("/frontend")
+    @ApiOperation("git下载代码进行评估")
     public ResponseEntity inspect(MultipartFile file) throws IOException {
 
         return ResponseEntity.ok(200);

src/main/java/com/zjty/inspect/controller/ParamController.java

@@ -2,6 +2,8 @@ package com.zjty.inspect.controller;
 
 import com.zjty.inspect.entity.InspectParameter;
 import com.zjty.inspect.service.ParameterService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
@@ -12,17 +14,20 @@ import org.springframework.web.bind.annotation.*;
  */
 @RestController
 @RequestMapping("/param")
+@Api(value = "参数页面管理接口",description = "参数页面管理接口,提供页面的增、删、改、查")
 public class ParamController {
 
     @Autowired
     private ParameterService parameterService;
 
     @GetMapping
+    @ApiOperation("获取参数")
     public ResponseEntity getParam(String id){
         return ResponseEntity.ok(parameterService.getParameterById(id));
     }
 
     @PostMapping
+    @ApiOperation("保存参数")
     public ResponseEntity saveParam(@RequestBody InspectParameter inspectParameter){
         parameterService.saveParameter(inspectParameter);
         return ResponseEntity.ok(200);

src/main/java/com/zjty/inspect/controller/RuleController.java

@@ -2,6 +2,8 @@ package com.zjty.inspect.controller;
 
 import com.zjty.inspect.entity.RuleQo;
 import com.zjty.inspect.service.RuleService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
@@ -14,6 +16,7 @@ import org.springframework.web.bind.annotation.*;
 
 @RestController
 @RequestMapping("/rule")
+@Api(value = "规则页面管理接口",description = "规则页面管理接口,提供页面的增、删、改、查")
 public class RuleController {
 
     @Autowired
@@ -25,6 +28,7 @@ public class RuleController {
      * @return
      */
     @PostMapping
+    @ApiOperation("新增规则")
     public ResponseEntity rule(@RequestBody RuleQo ruleQo){
         ruleService.addRule(ruleQo);
         return ResponseEntity.ok(200);
@@ -36,6 +40,7 @@ public class RuleController {
      * @return
      */
     @PostMapping(value = "/{id}")
+    @ApiOperation("修改规则")
     public ResponseEntity update(@RequestBody RuleQo ruleQo,@PathVariable String id){
         ruleQo.setId(id);
         ruleService.upRule(ruleQo);
@@ -46,11 +51,13 @@ public class RuleController {
      * @param id id
      * @return
      */
+    @ApiOperation("根据id删除规则")
     @DeleteMapping(value = "/{id}")
     public ResponseEntity deleteById(@PathVariable String id){
         ruleService.deleteById(id);
         return ResponseEntity.ok(200);
     }
+    @ApiOperation("根据name查询规则")
     @GetMapping(value = "/{name}")
     public ResponseEntity getName(@PathVariable String name) {
         ruleService.findByName(name);
@@ -60,6 +67,7 @@ public class RuleController {
      * 查询所有规则
      * @return 规则
      */
+    @ApiOperation("查询所有规则")
     @GetMapping
     public ResponseEntity getRules(){
         return ResponseEntity.ok(ruleService.findAll());

src/main/java/com/zjty/inspect/controller/TechnologyController.java

@@ -3,6 +3,8 @@ package com.zjty.inspect.controller;
 import com.zjty.inspect.entity.Technology;
 import com.zjty.inspect.entity.TechnologyQo;
 import com.zjty.inspect.service.TechnologyService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
@@ -15,6 +17,7 @@ import org.springframework.web.bind.annotation.*;
 
 @RequestMapping("/technology")
 @RestController
+@Api(value = "适配技术页面管理接口",description = "适配技术页面管理接口,提供页面的增、删、改、查")
 public class TechnologyController {
 
     @Autowired
@@ -25,10 +28,12 @@ public class TechnologyController {
      * @return List
      */
     @GetMapping
+    @ApiOperation("获取所有关键技术")
     public ResponseEntity getTechnologies(){
         return ResponseEntity.ok(technologyService.findAllTechnology());
     }
     @GetMapping("/names")
+    @ApiOperation("获取所有关键技术name")
     public ResponseEntity getTechnologiesName(){
         return ResponseEntity.ok(technologyService.findAllTechnologyNames());
     }
@@ -38,6 +43,7 @@ public class TechnologyController {
      * @return List
      */
     @GetMapping(value = "/{name}")
+    @ApiOperation("根据name获取所有关键技术")
     public ResponseEntity getTechnologies(@PathVariable String name){
         return ResponseEntity.ok(technologyService.findAllTechnology(name));
     }
@@ -46,17 +52,20 @@ public class TechnologyController {
      * @return List
      */
     @PostMapping
+    @ApiOperation("添加关键技术")
     public ResponseEntity addTechnologies(@RequestBody TechnologyQo technologyQo){
         technologyService.addAdvice(technologyQo);
         return ResponseEntity.ok(200);
     }
     @PostMapping("/add")
+    @ApiOperation("新添加关键技术")
     public ResponseEntity addTechnologies(@RequestBody Technology technology){
         technologyService.add(technology);
         return ResponseEntity.ok(200);
 
     }
     @PostMapping(value = "/{id}")
+    @ApiOperation("修改关键技术")
     public ResponseEntity update(@RequestBody Technology technology,@PathVariable String id){
         technology.setId(id);
         technologyService.update(technology);