Heim  >  Artikel  >  Java  >  Teilen Sie die Einführung von Swagger2+Validator

Teilen Sie die Einführung von Swagger2+Validator

零下一度
零下一度Original
2017-07-17 13:37:482789Durchsuche

Einführung:

Swagger ist eine RESTful-API zur Beschreibung von Projekten und Dokumenten.

Die Spezifikation hier definiert eine Reihe von Dateiformaten, die zur Beschreibung einer API erforderlich sind. Diese Dateien werden von Swagger-UI-Projekten verwendet, um die von API und Swagger-Codegen generierten Clients in verschiedenen Sprachen anzuzeigen. Auch weitere Tools können die generierten Dateien nutzen, beispielsweise Testtools.

><br>

Swagger2:
@Configuration
@EnableSwagger2public class Swagger2
{
    @Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dj.edi.web"))
                .paths(PathSelectors.any())
                .build();
    }private ApiInfo apiInfo() {return new ApiInfoBuilder()
                .title("EID 用户 CRUD")
                .description("EID 用户 CRUD")
                .version("1.0")
                .build();
    }

}
<span style="font-size: 18px"><strong>Application:<br></strong></span>
@SpringBootApplication
@Import(springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class)public class ComEdiOrderUserApplication
{public static void main(String[] args) {SpringApplication.run(ComEdiOrderUserApplication.class, args);}

}
UserApiController:
<br>
@RestController
@RequestMapping("/v1/user")public class UserApiController
{private static final Logger LOGGER = LoggerFactory.getLogger(UserApiController.class);

    @Autowiredprivate ClientUsersRepository repository;

    @ApiOperation(value = "获取所有用户数据")
    @RequestMapping(value = "/list", method = RequestMethod.GET)public ResponseEntity<List<ClientUsers>> getClientUsersList() {try {return ResponseEntity.ok(repository.findAll());
        } catch (Exception e) {
            LOGGER.info(" 获取所有用户数据异常 " + e.getMessage(), e);return ResponseEntity.status(500).body(null);
        }
    }

    @ApiOperation(value = "获取用户数据")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "String", paramType = "path")
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)public ResponseEntity<ClientUsers> getClientUsers(@PathVariable String id) {try {return ResponseEntity.ok(repository.findOne(id));
        } catch (Exception e) {
            LOGGER.info(" 获取用户数据  " + id + "  数据异常 " + e.getMessage(), e);return ResponseEntity.status(500).body(null);
        }
    }

    @ApiOperation(value = "创建用户", notes = "根据User对象创建用户")
    @ApiImplicitParam(name = "users", value = "用户详细实体user", required = true, dataType = "ClientUsers", paramType = "body")
    @RequestMapping(method = RequestMethod.POST)public ResponseEntity<ClientUsers> createUser(@Valid @RequestBody ClientUsers users) {try {

            users.setId(ObjectId.get().toString());return ResponseEntity.ok(repository.save(users));

        } catch (Exception e) {
            LOGGER.info(" 创建用户  " + users + "  数据异常 " + e.getMessage(), e);return ResponseEntity.status(500).body(null);
        }
    }

    @ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "String", paramType = "path"),
            @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "ClientUsers", paramType = "body")
    })
    @RequestMapping(value = "{id}", method = RequestMethod.PUT)public ResponseEntity<ClientUsers> updateUser(@PathVariable("id") String id,@Valid @RequestBody ClientUsers user) {try {
            user.setId(id);return ResponseEntity.ok(repository.save(user));
        } catch (Exception e) {
            LOGGER.info(" 更新用户  " + user + "  数据异常 " + e.getMessage(), e);return ResponseEntity.status(500).body(null);
        }
    }

    @ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "String", paramType = "path")
    @RequestMapping(value = "{id}", method = RequestMethod.DELETE)public ResponseEntity<String> deleteUser(@PathVariable String id) {try {
            repository.delete(id);return ResponseEntity.ok("ok");
        } catch (Exception e) {
            LOGGER.info(" 删除用户  " + id + "  数据异常 " + e.getMessage(), e);return ResponseEntity.status(500).body(null);
        }
    }
}

Das obige ist der detaillierte Inhalt vonTeilen Sie die Einführung von Swagger2+Validator. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn