使用swagger生成API的json文件

使用swagger生成API的json文件

使用swagger可以方便的生成REST API,最近有机会了解一下,就记录下小小的踩坑经历吧.


demo使用maven搭建,REST采用jersey,swagger的版本选用了新版(即io.swagger),接着就是要用到的swagger-maven-plugin了.

  1. 在pom.xml中添加plugin
                <plugin>
                    <groupId>com.github.kongchen</groupId>
                    <artifactId>swagger-maven-plugin</artifactId>
                    <version>3.1.0</version>
                    <configuration>
                        <apiSources>
                            <apiSource>
                                <springmvc>false</springmvc> <!-- false为JAX-RS -->
                                <locations>com.rooyeetone.rtprest.rest</locations>
                                <schemes>http,https</schemes>
                                <host>
  • 0
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 7
    评论
Swagger 是一种用于构建、设计和文档化 RESTful API 的工具。它提供了一个简单易用的界面,让开发者可以定义 API 的各种细节,包括端点、参数、请求和响应等。Swagger 还可以根据用户的定义自动生成 OpenAPI JSON,这是一种机器可读的 API 文档格式。 Swagger 生成 OpenAPI JSON 的过程非常简单。首先,我们需要在 Swagger 的配置文件或注解中定义我们的 API。在定义 API 时,我们需要指定每个端点的路径、请求方法、请求参数、请求体和响应内容等。为了使生成的 OpenAPI JSON 更加准确和完整,我们还可以添加其他的元数据,比如 API 的标题、描述、版本号等。 当我们完成 API 的定义后,我们可以使用 Swagger 提供的工具自动生成 OpenAPI JSON。通常,我们只需要运行一条命令或点击一个按钮,Swagger 就会根据我们的定义扫描我们的 API,并生成一份符合 OpenAPI 规范的 JSON 文件。这份文件包含了 API 的详细信息,包括端点的路径、请求方法、请求和响应的参数等。生成JSON 文件可以供其他开发者和工具使用,比如用于生成文档、进行代码生成等。 总之,Swagger 是一个强大的工具,可以帮助我们快速构建、设计和文档化 RESTful API。通过定义 API,并使用 Swagger 提供的工具生成 OpenAPI JSON,我们可以更方便地与其他开发者进行协作,并提供高质量的 API 文档。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 7
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值