首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >从Java -> Swagger生成UI模型

从Java -> Swagger生成UI模型
EN

Stack Overflow用户
提问于 2022-09-06 08:31:46
回答 1查看 107关注 0票数 1
  • 我可以用 io.swagger.codegen.v3 swagger-codegen-maven-plugin ${swagger-codegen-maven-plugin.version} 要从swagger-ui.yml文件(手动编写)创建UI (TypeScript)和后端(Java)模型,我不希望Swagger生成端点(我想用Java编写它们)。
  • 我还可以在运行时使用springfox- Swagger 2+ springfox-swagger-ui访问一个新的swagger文件(2.9.2) io.springfox springfox-swagger 2.9.2 io.springfox springfox-swagger-ui 2.9.2

我希望(模型和端点)编写所有东西,然后生成swagger-ui.yml,然后从swagger-ui.yml文件生成TypeScript模型(就像我可以使用swagger.codegen那样),尽管我没有成功地将这两种方法结合在一起。或者有没有其他方式(其他依赖,等等)?做这件事?我还需要Swagger文件来包含端点文档,比如使用springfox-swagger。(我使用的是Maven,spring starter,Java 8,角13。)

EN

回答 1

Stack Overflow用户

发布于 2022-09-06 08:50:55

其思想是Swagger将为您提供"API“端点(作为接口),您将用Java编写"API实现”。

例如,在swaggerui.yml文件中:

您的MyappApi类可能如下所示:

代码语言:javascript
运行
复制
@Api(description = "the myapp API")
@javax.annotation.Generated(...)public interface MyappApi {
    // ... Endpoints go here
}

然后像这样写MyappApiImpl:

代码语言:javascript
运行
复制
public class MyappApiImpl implements MyappApi {
    // ... Override methods here
}

请注意,非常重要的是,TypeScript类和Java端点保持同步。您不希望用Java手动编写所有东西-让Swagger定义API实现(服务器端,用于Java),并且只定义实现。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/73618987

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档