vscode 中node项目api　生成swagger文档

最新推荐文章于 2023-08-28 14:34:23 发布
最新推荐文章于 2023-08-28 14:34:23 发布
阅读量2.5k 收藏
点赞数
分类专栏： node 文章标签： node
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Velly_zheng/article/details/103871916
版权

１．安装插件　swagger viewer

2.安装完成后，仔细阅读插件文档

查看swagger文档方式之一，进入api代码页面，使用快捷键shift+alt+p

方式之二，右键选中文档目录，点击preview swagger

 

Velly_zheng
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
在Visual Studio 2017中创建 Web API并整合Swagger
05-29
Swagger是一种与技术无关的标准，允许发现REST API，为任何软件提供了一种识别REST API功能的方法。 这比看起来更重要：这是一个改变游戏技术的方式，就像Web服务描述语言一样WSDL（Web Service Description Language）一样。 WSDL一直是使Visual Studio等工具和IDE 可以理解Web服务并创建代理类的基础技术。此功能将Web服务的消耗转换为高级任务，封装所有协议详细信息。 这是Swagger的重要性：它可以为REST API做出WSDL已经为Web服务所做的工作，允许创建代理和使用Web API更容易。 VS 2017包括使用Swagger协议支持REST API代理创建。它还处于早期阶段，缺乏一些特点，但这是向广泛采用Swagger迈出的重要一步。 我们将创建一个例子，说明我们如何使用Swagger与VS 2017来分析优势和缺少的功能。 以及VS 2017，我们还将需要安装在开发机器中的IIS（Internet Information Server）作为示例。
vscode 插件开发 (选择内容掉swagger接口生成对应的注释)
m0_63108819的博客
03-20 690
注：谷歌浏览器图片看不见的，可以用火狐或者其他浏览打开看看。比如 建立一个 summary.ts。
vscode前端代码生成器，根据接口文档生成
qq_38998388的博客
08-01 2528
​ 前后端开发过程中，后端都会提供swagger、yapi类型的接口文档，开发过程中反复CV？为了开发提效，做了个codegen接口文档代码生成工具，可根据接口定义快捷生成表格、表单、api定义，typescript定义等等前端代码，更可以在线维护自定义生成方法模板。......
Visual studio code整合Swagger-ui简易方法
Cqing
12-06 9033
1、首先我们需要安装swagger-ui依赖包 在终端控制台输入命令:dotnet add YourProjectName.csproj package Swashbuckle.AspNetCore 2、添加配置和Swagger中间件 在Startup.cs文件的ConfigureServices方法内添加代码如下: // Register the Swagger generator, def...
VS Code 必备插件推荐
小贤笔记
08-12 1万+
插件 说明 备注 Auto Close Tag 自动添加HTML / XML关闭标签 Auto Rename Tag 自动重命名配对的HTML / XML标签 Beautify 格式化代码 (查看使用方法) Bracket Pair Colorizer 颜色识别匹配括号 Code ...
swagger 接口文档生成与导出
热门推荐
起航
05-09 5万+
1，接口生成 1.1 外部环境 jdk1.8 spirng-boot ：2.0.3.RELEASE 1.2 依赖 <!-- swagger 接口生成插件 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui&l...
使用Swagger自动生成接口文档
duhuahuaya的博客
03-24 3578
安装swagger 链接: link 1.打开vscode，在终端输入： npm install --save @nestjs/swagger swagger-ui-express 应用swagger 1.打开入口文件main.ts，在引用里面加入 import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; 2.打开入口文件main.ts，在引用里面加入 const config = new DocumentBuilder()
Swagger使用教程
最新发布
jakelihua
08-28 2283
Swagger官网Swagger是一个用于设计、构建、文档化和使用RESTful风格的Web服务的开源软件框架。它提供了一种简单而强大的方式来描述和访问API的功能，使得开发人员可以更轻松地构建和测试API。Swagger的主要功能包括：API文档自动生成：Swagger可以根据代码注释自动生成API文档，包括API的路径、参数、请求和响应的格式等信息。可视化界面：Swagger提供了一个可视化的界面，使开发人员可以直观地查看和测试API。
vscode插件开发之Swagger生成Ts
a1196324866的博客
11-23 2730
vscode插件开发之Swagger生成Ts。当后端同学给到我们Swagger接口文档的时候，是不是在为要写接口类型烦恼，为了偷懒，那么就any吧。any一时爽，同事泪两行。为了高质量的偷懒，来开发个插件。利用SwaggerApiJson和vscode的webVIew功能。
asp.ner core 5.0 Grpc双向认证 和 restful api包装 外加swagger启用【VSCode创建】
dz45693的专栏
01-03 2130
关于grpc 我以前的文章.Net Core3.0使用gRPC 和IdentityServer4已经很向详细了， 关于http的双向认证 也已经有了， 大家可以参考asp.net 5.0 https的双向认证(windows和ubuntu)，今天主要试一下 在vccode 里面怎么完成全部的操作，证书还是用asp.net 5.0 https的双向认证(windows和ubuntu)里面的， 结尾我会贴下来创建代码 Grpc Server 1.创建grpc server 创建结果如图： ...
VS Code-插件
风吹草动的博客
01-10 1676
VS Code-插件SpringBootSpring Boot ToolsSpring Initializr Java SupportSpring Boot DashboardLombok Annotations Support for VS CodeJava Extension PackSwagger ViewerNodejsNode.js Modules IntellisenseDebugge...
swagger-viewer-crx插件
03-09
显示Swagger-UI呈现的swagger yaml / json 该扩展将swagger代码替换为GitHub中的预览html。 完全脱机工作。 ##演示###易于转换https://raw.githubusercontent.com/arx-8/swagger-viewer/master/README-Demo_1.gif ###易于扩展/折叠https：//raw.githubusercontent com / arx-8 / swagger-viewer / master / README-Demo_2.gif ##规格。 -支持的网站。 -GitHub-支持的OpenAPI版本。 -2.0-3.0-支持的文件扩展名。 -yaml-yml-json ##用法1.安装此应用程序。 2.在GitHub中打开招摇页面。 - 尝试： <https>3.单击此应用程序图标。 4.有一个良好的发展！ </https> 支持语言:English
swagger-viewer：Swagger-UI的Chrome扩展
01-30
摇摇欲坠的观众 总览 这是Chrome扩展程序。 显示Swagger-UI呈现的swagger yaml / json。 该扩展将ssagger代码替换为GitHub中的预览html。 完全脱机工作。 演示版 容易转换 易于扩展/折叠 规格 支持的站点。 的GitHub 支持的OpenAPI版本。 2.0 3.0 支持的文件分机。 yaml yml json 用法 从安装此应用 在GitHub中打开招摇页面。 尝试： : 单击此应用程序图标。 有一个好的发展！
使用node生成swagger接口文档
01-08
这里不在讲解node怎么安装，接口怎么写，直接写接口文档生成的那部分，如果想看怎么使用node接口的话，可以移动到https://blog.csdn.net/Govern66/article/details/104290198这篇博客 最终案例我已经上传github中...
markdown-swagger：将Swagger文件中的API文档生成为markdown文件
02-04
将Swagger文件中的API文档生成为markdown文件。 安装 npm install markdown-swagger 用法 markdown-swagger ./api/swagger/swagger.yaml ./README.md 这将读取指定的swagger文件并生成一个表，该表描述目标markdown...
项目API文档在线自动生成 Swagger UI.zip
07-19
Swagger UI是一款RESTFUL接口的文档在线自动生成 功能测试功能软件。 现在多数的项目开发中，网站和移动端都需要进行数据交互和对接，这少不了使用REST编写API接口这种场景。例如有些团队，移动端交由了另一团队...
asp.net webapi集成swagger自动生成接口文档(亲测可用)
03-25
asp.net webapi集成swagger自动生成接口文档(亲测可用)swagger生成html离线接口文档swagger生成html离线接口文档
Asp.net core WebApi 使用Swagger生成帮助页实例
10-19
本篇文章主要介绍了Asp.net core WebApi 使用Swagger生成帮助页实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
swagger的使用与步骤
JackMa的博客
01-11 5197
ApiOperation(value = "查询所有用户", notes = "查询所有用户信息")代表对接口的描述。@Api(tags = "用户控制")代表对这个controller的描述。@ApiModelProperty属性：notes：描述该实体类属性的信息。@ApiModel属性：description：用于描述实体类。注意，端口是自己tomcat启动时的端口，以自己电脑的为准。上添加两个注解，开启Swagger功能。6、Controller接口配置。5、swagger配置类。
Micronaut项目生成OpenAPI Swagger文档
07-14
Micronaut框架提供了生成OpenAPI Swagger文档的功能。要在Micronaut项目中生成OpenAPI Swagger文档，你可以按照以下步骤进行操作： 1. 首先，确保你的Micronaut项目中已经添加了Swagger支持的依赖。在你的构建工具（如Gradle或Maven）的配置文件中，添加以下依赖： Gradle: ```groovy implementation 'io.swagger.core.v3:swagger-core:2.1.1' implementation 'io.swagger.core.v3:swagger-jaxrs2:2.1.1' implementation 'io.swagger.core.v3:swagger-annotations:2.1.1' ``` 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文档的一种方法，你也可以使用其他工具或插件来实现相似的功能。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值