# 休息 API Java Spring 服务的 REST API 标准。 ## 什么时候使用这个技能 * 在 Spring 服务中创建 REST 端点 * 集成Bitso认证 * 使用 OpenAPI 记录 API * 设置服务文档 (RFC-37) * 测试经过身份验证的端点 ## 技能内容 ### 部分 * 何时使用该技能 * 快速启动 * 认证 * 文档 * 参考文献 * 相关规则 * 相关技能 ### 可用资源 **📚参考文献/** \- 详细文档 * [文档]() * [指南]() ** ** ## 快速入门 ### 1\.添加身份验证依赖项实现 libs.bitso.api.base.spring.webapi ### 2\.配置 gRPC 客户端组组：客户：用户安全：地址： dns:/${USER_SECURITY_HOST:localhost}:${GRPC_PORT:8201} 协商类型：PLINTEXT ### 3\.创建控制器 @RestController @RequestMapping("/") 公共类 MyController { @Autowired SpringHttpResponseFactoryresponseFactory; @Autowired WebAuthenticationContext 身份验证上下文； @GetMapping("/私人") @WebAPI(WebAPIType.PRIVATE) 公共 ResponseEntity privateEndpoint() { 长 userId =authenticationContext.getPrincipalId(); 返回responseFactory.ok(userId); } } ## 身份验证 ### 配置Bean @配置公共类 UserSecurityContextConfiguration { @豆子 @小学公共身份验证服务身份验证服务（ @GrpcClient("用户安全") AuthorizationServiceV1BlockingStub 存根， @Qualifier("userSecurityResilienceConfig") ResilienceConfiguration 配置）{ 返回新的 ProtoShimAuthenticationService(config, 存根); } } ### 组件扫描确保您的主应用程序扫描 Bitso 组件： @SpringBootApplication @ComponentScan("com.bitso.*") 公共类我的应用程序{ 公共静态无效主（字符串[] args）{ SpringApplication.run(MyApplication.class, args); } } ## 文档 ### OpenAPI 规范所有端点都应记录在“./docs/api/rest/openapi.yaml”下 ### RFC-37 文档结构文档/ ├── API/ │ ├── 异步/ │ ├── grpc/ │ └── 休息/ ├── 决定/ ├── <域名>/ ├── 操作手册/ └── 操作方法/ └── 本地执行.md ## 参考文献参考|描述 ---|--- [references/guidelines.md]() | API指南、认证、测试 [references/documentation.md]() | RFC-37 文档标准 ## 相关规则 * [java-rest-api-guidelines]() \- 完整的 API 指南 * [java-service-documentation]() \- RFC-37 文档 ## 相关技能技能|目的 ---|--- [grpc-services-rfc-33]() | gRPC服务标准 [java-testing]() |测试 REST 端点

休息API

包含技能