> Java > java지도 시간 > Swagger2+validator 소개 공유

Swagger2+validator 소개 공유

零下一度
풀어 주다: 2017-07-17 13:37:48
원래의
2816명이 탐색했습니다.

소개:

swagger는 프로젝트와 문서를 설명하는 데 사용되는 RESTful API입니다.

여기 사양은 API를 설명하는 데 필요한 파일 형식 집합을 정의합니다. 이러한 파일은 Swagger-UI 프로젝트에서 API 및 Swagger-Codegen 생성 클라이언트를 다양한 언어로 표시하는 데 사용됩니다. 테스트 도구와 같은 추가 도구도 생성된 파일을 활용할 수 있습니다.

 <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);
        }
    }
}
로그인 후 복사
<br>
로그인 후 복사
로그인 후 복사
ClientUsersRepository:<br>
로그인 후 복사
@Componentpublic interface ClientUsersRepository extends MongoRepository<ClientUsers, String>{
    ClientUsers findByips(String ip);
    ClientUsers findByclientFlag(String clientFlag);
}
로그인 후 복사
ClientUsers:<br>
로그인 후 복사
@Datapublic class ClientUsers implements Serializable
{

    @Idprivate String id;/** * 用户名称     */@NotBlank(message = "用户名称 不能为空")
    @Pattern(regexp = "^(?!string)",message = "不能是 stirng")private String userName;/** * ip     */@NotNull(message = "ip 至少需要个")private List<String> ips;/** * 标识     */@NotBlank(message = " 标识 不能为空")
    @Pattern(regexp = "^(?!string)",message = "不能是 stirng")private String clientFlag;/** * 客户服务ID     */@NotBlank(message = "客户服务ID 不能为空")
    @Pattern(regexp = "^(?!string)",message = "不能是 stirng")private String checkID;
}
로그인 후 복사

有哪里不好的希望指正
로그인 후 복사
 <br>
로그인 후 복사

위 내용은 Swagger2+validator 소개 공유의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

관련 라벨:
원천:php.cn
본 웹사이트의 성명
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.
인기 튜토리얼
더>
최신 다운로드
더>
웹 효과
웹사이트 소스 코드
웹사이트 자료
프론트엔드 템플릿