IDEA插件：OpenAPI ​(Swagger)​ Editor的使用（swagger3、OpenAPI3、swagger-codegen生成java代码）

最新推荐文章于 2025-03-26 13:32:56 发布
最新推荐文章于 2025-03-26 13:32:56 发布
阅读量1.7w 收藏 15
点赞数 1
文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jjddppz/article/details/118327359
版权

目录

步骤一：安装

步骤二：创建 定义文件

步骤三：编写 YAML或者JSON、快速定位、本地调试

步骤四：预览 swagger-ui

步骤五：生成代码

OpenAPI

是一个规范的名称。

3.0版本的对RESTful API方面做得很好。

Swagger

是一个 API文档维护组织，后来成为了 Open API 标准的主要定义者。自2017年宣Swagger2停止维护，新发布的 Swagger3（Open Api3）。

OpenAPI ​(Swagger)​ Editor

OpenAPI ​(Swagger)​ Editor是 IntelliJ IDEA 的一款插件 https://plugins.jetbrains.com/plugin/14837-openapi-swagger-editor/versions

可以通过它来编写YAML使用完美定义Open Api规范的接口，生成Java代码。

演示工具：

IntelliJ IDEA 2021.1.2 (Ultimate Edition)

OpenAPI ​(Swagger)​ Editor 1.18

步骤一：安装

安装 OpenAPI ​(Swagger)​ Editor，同时OpenAPI Specifications会被绑定安装。

步骤二：创建 定义文件

例：选择 OpenApi3.0的yaml文件

步骤三：编写 YAML或者JSON、快速定位、本地调试

步骤四：预览 swagger-ui

步骤五：生成代码

1、设置api的定义文件

2、设置代码生成目录

3、设置生成器，此处加载自定义jar openapi-generator-cli-5.0.0.jar

4、然后运行即可

Jjddppz
关注
Swagger 插件
dccpiao的博客
03-30 1957
1、安装Swagger插件访问地址：http://localhost:8080/fsoa.usermanager.web/swagger-ui.html#/2、Controller层（参考）package com.foriseland.open.controll;import java.util.List;import javax.servlet.http.HttpServletResponse;...
IDEA插件-SwaggerModelDoc
jeofey的专栏
11-18 6594
平时开发Restful接口时，喜欢用Swagger做自动接口展示调用的小伙伴有福了~ 如果想通过Swagger展示接口注释，需要在实体上添加Swagger注解，该插件可以根据javadoc的注释自动添加Swagger注解，解释呢编码时间。 第一步：下载该插件的jar：下载地址：SwaggerModelDoc.jar下载 第二部本地安装：File-->Settings-->Plugins-->
Idea集成Swagger插件并使用
架构师之路。。
11-27 1845
2.打开plugins，搜索Swagger Tools。1.打开idea ，File-setting。3.新增测试类，加上注释。
intellij-swagger：一个可帮助您轻松编辑IntelliJ IDEA中的Swagger和OpenAPI规范文件的插件
02-03
Swagger插件 Swagger插件可轻松在IntelliJ IDEA中编辑Swagger和OpenAPI规范文件。 您可以在JetBrains的上找到它。 用法 打开Swagger或OpenAPI规范文件即可。 自定义扩展 您可以扩展自动完成功能以提供自定义键和和值。 该插件为此提供了以下扩展点： < extensionPoints> < extensionPoint qualifiedName = " org.zalando.intellij.swagger.customFieldFactory " interface = " org.zalando.intellij.swa
IDEA 的 AI 编程插件推荐清单，大大提升你的开发效率！
最新发布
itwangyang520的博客
03-26 4263
AWS 深度集成，擅长生成云服务（如 Lambda、S3）代码。插件市场直接安装，免费版够用，Pro 版支持全代码库学习。通义灵码 + CodeGeeX → 中文支持 + 免费高效。基于 ChatGPT，支持生成测试用例、文档和代码解释。OpenAI 驱动，代码生成精准度高，支持多语言。阿里云出品，中文注释生成代码，无缝对接云服务。清华团队开发，完全免费，支持代码翻译/解释。免费开源，支持代码生成和搜索代码库相似片段。本地模型可选，隐私保护强，响应速度快。免费基础版，支持 CLI 命令生成。
超好用的IDEA插件推荐！自带API调试功能
Xayh55的博客
10-26 727
支持在插件中获取 token、支持代码完成后在插件中进行 API调试 ，同时也保留了1.0版本部分功能如上传选择目录功能等。请求token可以在Apipost 「项目设置」- 「对外能力」-「openAPI」中创建使用，也支持在IDEA中直接获取请求token。V1版本还会继续保留开源，方便各位进行自创魔改。安装Apipost helper V2版本后可以点击IDEA右侧的Apipost按钮对接口进行简单调试。同步完成后会有提示信息，点击去调试可以跳转至Apipost页面，点击分享可以生成接口文档链接。
IntelliJ IDEA 的 AI 编程插件推荐清单，助你高效选择
weixin_43973672的博客
03-13 2508
国际插件（如 Copilot）需稳定访问外网，国内插件可直连。：插件市场直接安装，免费版够用，Pro 版支持全代码库学习。：基于 ChatGPT，支持生成测试用例、文档和代码解释。：插件市场搜索安装，需绑定 OpenAI API Key。：OpenAI 驱动，代码生成精准度高，支持多语言。：阿里云出品，中文注释生成代码，无缝对接云服务。：清华团队开发，完全免费，支持代码翻译/解释。：企业用户需审核生成代码，避免知识产权风险。：本地模型可选，隐私保护强，响应速度快。：API 调用需自费，响应速度依赖网络。
swagger插件
12-01
swagger框架作为Java开发人员的一个交互工具，在前后端开发分离是，利用此工具进行前端数据访问测试
openapi：swagger-ui/swagger-editor 部署
test1280
11-06 1366
openapi：搭建部署 swagger-ui/swagger-editor 1.下载 swagger-ui/swagger-editor 源码 git clone https://github.com/swagger-api/swagger-ui git clone https://github.com/swagger-api/swagger-editor 注：可以从github上下载过往版本...
Swagger Editor 的介绍和使用
chenxy02的博客
02-20 888
Swagger Editor 可以帮助开发人员优雅地设计符合 OpenAPI 规范的API接口，是一个可以通过浏览器进行使用的工具。功能如下：编辑：可以在浏览器上基于YAML等语法定义我们的RESTful API，也可以采用 JSON语法查看：Swagger Editor会自动生成一篇排版优美的API文档，并且提供实时预览生成代码：可智能生成服务端或客户端代码，支持 python、golang、java 等主流语言。
idea生成swagger注解插件,最新版23.2也能用
12-01
根据字段上的doc注释生成swagger注解 @ApiModelProperty(value = "当前登录人名称") 快捷键 ctrl+n \command+n \右键Generate 打开generate页面，选择swagger
openapi-gui:GUI可视化编辑器，用于创建和编辑OpenAPI Swagger定义
05-02
OpenAPI的GUI OpenAPI-GUI是用于创建和编辑OpenAPI 3.0.x版JSON / YAML定义的GUI。 以当前形式，它最适合作为开始和编辑简单OpenAPI定义的工具。 导入的OpenAPI 2.0定义会自动转换为v3.0。 对于以前的Swagger / OpenAPI 2.0-only版本，请参见。 除安全修复程序外，该版本目前尚未维护。 这个项目最初是一个分支，而灵感是Ruby编写编写的 。 该项目的完整历史记录保存在GitHub上。 描述 这个怎么运作 选择一个现有的OpenAPI 2.0或3.0.x定义进行上传，或创建一个新定义并开始添加路径，操作和参数。 使用现有定义时，将对其进行解析并创建用于编辑每个Path，Operation和Parameter的表格。 您可以通过将?url=查询参数附加到初始起始页来加载现有定义。 从左侧菜单中单击一个项目
openapi-typescript-codegen：基于OpenAPI规范生成Typescript或Javascript客户端的NodeJS库
02-08
前端 :red_heart_selector: OpenAPI，但我们不想在构建中使用JAVA代码生成 快速，轻巧，强大且与框架无关 :rocket: 支持生成TypeScript客户端 支持几代访存和XHR http客户端 支持OpenAPI规范v2.0和v3.0 支持JSON...
swagger-node-codegen:适用于Node.js的OpenAPI 3.xSwagger 2代码生成器
05-11
使用您的API OpenAPI 3.x / Swagger 2定义为您的API生成与Node.js ES7兼容的代码。 生成的代码功能： ES7 ESLint YAML配置文件 表示 禁止转码 安装 要从CLI使用它： npm install -g swagger-node-codegen 要将其...
java8看不到源码-swagger-codegen-springboot:准备使用Swagger代码生成示例，使用swagger-codeg
06-04
swagger-codegen-maven-plugin 及其使用方法的最新文档并不容易找到。 该项目的目标是： 展示如何使用 OpenAPI 规范文件生成服务器代码（此处为接口和模型类）。 避免代码生成时覆盖代码的问题。 提供一个已设置并...
swagger-axios-ts-generator:通过swagger openapi自动生成axios-ts代码
04-07
@ toft-code / swagger-axios-ts-generator 安装 $ npm install @toft-code/swagger-axios-ts-generator $ yarn add @toft-code/swagger-axios-ts-generator 例子 打字稿 import { generate } from &#39;@toft-code/...
swagger-gradle-codegen：:dizzy:一个Gradle插件，用于从Swagger生成您的网络代码
02-03
`swagger-gradle-codegen` 是一款基于 Gradle 的插件，它的主要功能是自动生成网络请求代码，这些代码通常是根据 Swagger 规范（现在称为 OpenAPI 规范）编写的。Swagger 是一种广泛使用的工具，它允许开发者通过 ...
IDEA 开发者的全能 API 调试与管理神器
java_ws_love的专栏
02-17 372
Fast Request是一款集成于IntelliJ IDEA的插件，主要服务于Java开发者在IDE内完成API调试、参数管理与文档生成。该工具基于SpringMVC等框架的注解解析能力，可自动生成接口请求模板。提供OpenAPI 3.0、Markdown格式导出功能，支持与第三方API管理工具的数据互通。点击方法左侧 R 按钮，即可自动生成方法对应的参数和 url，非常方便。支持Spring系列框架、JAX-RS规范，并包含对Solon框架的实验性支持。本文由博客一文多发平台。
Swagger Editor 教程
qq_43256905的博客
12-23 3888
Swagger Editor 教程 文章目录Swagger Editor 教程一、swagger 是什么二、Swagger Editor1. Swagger Editor 简介2. 下载安装① 在线版② Windows 本地3. 具体使用步骤① 准备工作② 编写 yaml③ 服务端代码1）api_XX.go2）model_XX.go3）logger.go4） route.go 一、swagger 是什么 OpenAPI 是描述 REST API 的标准规范。 OpenAPI 描述允许人类和计算机无需首先阅
Micronaut项目生成OpenAPI Swagger文档
07-14
Micronaut框架提供了生成OpenAPI Swagger文档的功能。要在Micronaut项目中生成OpenAPI Swagger文档，你可以按照以下步骤进行操作： 1. 首先，确保你的Micronaut项目中已经添加了Swagger支持的依赖。在你的构建工具（如Gradle或Maven）的配置文件中，添加以下依赖： Gradle: ```groovy implementation &#39;io.swagger.core.v3:swagger-core:2.1.1&#39; implementation &#39;io.swagger.core.v3:swagger-jaxrs2:2.1.1&#39; implementation &#39;io.swagger.core.v3:swagger-annotations:2.1.1&#39; ``` Maven: ```xml <dependency> <groupId>io.swagger.core.v3</groupId> <artifactId>swagger-core</artifactId> <version>2.1.1</version> </dependency> <dependency> <groupId>io.swagger.core.v3</groupId> <artifactId>swagger-jaxrs2</artifactId> <version>2.1.1</version> </dependency> <dependency> <groupId>io.swagger.core.v3</groupId> <artifactId>swagger-annotations</artifactId> <version>2.1.1</version> </dependency> ``` 2. 在你的Micronaut应用程序的配置文件中，添加以下配置： ```yaml micronaut: application: openapi: paths: # 设置OpenAPI文档生成的路径 spec: /swagger ``` 3. 在你的Micronaut应用程序的控制器类或方法上，使用Swagger注解来描述API的信息，例如： ```java import io.micronaut.http.MediaType; import io.micronaut.http.annotation.Controller; import io.micronaut.http.annotation.Get; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; @Controller("/api") @Tag(name = "Example") public class ExampleController { @Get(value = "/hello", produces = MediaType.TEXT_PLAIN) @Operation(summary = "Say hello") public String hello() { return "Hello World!"; } } ``` 4. 启动你的Micronaut应用程序，并访问`http://localhost:port/swagger`，其中`port`是你应用程序的端口号。你将能够看到生成的OpenAPI Swagger文档，并可以在Swagger UI中浏览和测试API。 以上就是在Micronaut项目中生成OpenAPI Swagger文档的基本步骤。通过使用Swagger注解，你可以进一步定制和描述你的API。请注意，这只是Micronaut生成OpenAPI Swagger文档的一种方法，你也可以使用其他工具或插件来实现相似的功能。
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值