- 综合排序
- 最热优先
- 最新优先
- 来自专栏peakxie
OpenAPI初探
很快发现openapi可以通过写标准的yaml，可以通过yaml生成代码和文档。 Openapi yaml的格式如下： 1.png 编辑好yaml，使用如下命令： docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli 也许指定的模板不符合你的框架，也可以下载开源的代码生成工具：https://github.com/OpenAPITools/openapi-generator 4.png 在模板目录下，增加对应的mustache
5.6K60发布于 2019-08-29 - 来自专栏三木的博客
OpenAPI 概要
OpenAPI是什么？ OpenAPI被用来描述基于HTTP的API，是目前被广泛接受和使用的API工业标准。 格式: JSON 或者 YAML 最小化结构: openapi: 3.1.0 # OpenAPI版本 info: title: A minimal OpenAPI document version "X", "O"] parameters对象 paths: /users/{id}: get: parameters: - name: id # 必须有的，定义参数名 in: path # 必须有的，定义参数的来源，可以是 path, query, header中的一个 required: true # 可选的 schema And an extra one. description对象中也支持markdown的语法 OpenAPI Generator OpenAPI Generator可以根据OpenAPI的API描述文件自动生成客户端
96010编辑于 2024-10-09 - 来自专栏小二十七
拥抱 OpenAPI 3: springdoc-openapi 食用指南
概述 使用 springdoc-openapi 可以快速为 springboot 项目生成规范的 API 文档，具体使用步骤如下： 依赖配置 在 pom.xml 加入内容，即可开始使用： <dependency > <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version springOpenAPI() { return new OpenAPI() .info(new Info() 的理由如下： springdoc-openapi 是 spring 官方出品，与 springboot 兼容更好（springfox 兼容有坑） springdoc-openapi 社区更活跃，springfox 已经 2 年没更新了 springdoc-openapi 的注解更接近 OpenAPI 3 规范 综上所述，我个人还是更加推荐使用 springdoc-openapi 来自动化你项目的 API 文档
8.4K30编辑于 2022-11-11 - 来自专栏快乐阿超
openapi-generator
——林则徐 分享一个开源项目：openapi-generator 可以生成对外的api 官方文档：https://openapi-generator.tech/ 还有教程
1.3K20编辑于 2023-05-11 - 来自专栏程序员
DRF自动生成OpenAPI文档
DRF自动生成OpenAPI文档 API schemas是非常有用的，可以帮助我们生成接口文档以及可与API交互的动态客户端。 Django REST Framework支持自动生成OpenAPI schemas，但是目前支持的不是非常完善，需要手动修改的地方过多。 Schemas中的描述，description是来自于序列化器的文档字符串，而各个字段的title是来自于字段的label，带有*的意味着是必传的字段，除此之外，字段的其它描述是直接取自序列化器字段中的参数 # 返回错误信息 return Response({'msg': '保存失败'}, status=400) 对于HTTP Body中的内容，都在序列化器中描述了，但是对于URL参数 的规范，有一篇不错的文章，可以看看OpenAPI 规范摘要。
3.2K20编辑于 2021-12-21 - 来自专栏泛泛聊后端
Spring Boot使用OpenAPI规范
常规的方案就是使用OpenAPI规范，它的前身即大名鼎鼎的Swagger。 注解 OpenAPI 是Swagger v3 ，所使用的注解跟原来的有所区别。 描述接口参数 @Schema @ApiModel 描述模型 @ApiResponse @ApiResponse 描述返回的结果，包含返回码，信息等 交互式文档 ip:port/swagger-ui/ 点开其中一个方法，有具体的描述，方法的用处，参数和返回等上述注解中所定义的内容。 ? 点击右上角的【try it out】按钮，则可以出现一个模拟请求的交互界面。 ? 填入对应的参数，然后点击【Execute】按钮即可发起请求，然后在Responses看到对应的结果。同时也有Curl和Request URL给出，可以比较方便地复制到其他地方使用。
4.5K20发布于 2020-10-23 - 来自专栏小二十七
OpenAPI 3.0 规范-食用指南
概述 OpenAPI 3.0 规范由 8 个根对象组成： openapi info servers paths components security tags externalDocs OpenAPI 的其余功能都是基于这 8 根对象扩展而成，凡是包含以上对象并且扩展名为 json，yaml 的文件，我们可以将其视为符合 OpenAPI 规范的描述文件 ，你可以在：API Editor 在线编辑器 中来验证你的 OpenAPI 文件是否符合规范，以下我们就主要介绍 8 个根对象的使用和扩展方法 openapi 对象 openapi 是最简单也是最基础的属性，我们为 OpenAPI 添加第一个根对象属性 ，描述如下，（ requestBody 描述不在此列包含系列属） name：参数名称 in：参数出现的位置，通常是 header，path，query，cookie description：参数的描述（ 支持 markdown） required：必填项 deprecated：是否弃用 allowEmptyValue：允许提交空值 style：参数序列化方式 explode：与数组相关的参数 schema
15.6K31编辑于 2022-11-11 - 来自专栏全栈程序员必看
openwrt外网web管理_OpenAPI
将传入一个名为instance的参数，这个参数代表当前 OpenERP 的 Web 客户端实例， 包含了所有相关当前会话数据，以及所有 Web 模块的变量。 $el 当你在部件中重载init()时，必须以父部件作为第一参数传入，并调用传入给this. xml version=”1.0″ encoding=”UTF-8″? Widget.trigger(event_name [ , …]) 方法的第一个参数是待触发的事件名，也接受任何数量的其他参数。这些参数将被传递到所有的事件侦听器。 当func被调用时，trigger()的其他参数会传递给它。
7.2K10编辑于 2022-11-17 - 来自专栏后台技术汇
OpenAI的 OpenAPI 规范简介
背景 OpenAI OpenAPI 规范是由 OpenAI 官方发布的一个开源项目，旨在为 OpenAI API 提供标准化的接口定义。 开发者按照OpenAI API规范（RESTful架构）组装请求参数，包括： ✓ 模型选择（如GPT-3.5/4） ✓ 输入文本（prompt） ✓ 参数配置（temperature, max_tokens 验证请求合法性（身份鉴权、参数校验）。 分配计算资源，将请求传递至对应模型服务。 服务器处理请求 模型处理/文本生成 构建API响应 请求报文-body参数 请求body提供了多个参数和选项，用于控制生成结果的质量、多样性和长度等特性。 下面是一个curl案例： 常见的一些参数是：Temperature/Top_k/Top_p 其他的可选参数： 请求报文-messages 参数 messages 必须是消息对象 ( message object
4.9K10编辑于 2025-07-24 OpenAPI 文档代码生成工具
前言 OpenAPI 文档是基于 OpenAPI 规范（OpenAPI Specification, OAS）撰写的，主要用于描述 RESTful API 的一种标准化方式。 而 OpenAPI 代码生成工具是一类基于 OpenAPI 规范自动生成代码的工具。通过这些工具，开发者可以快速生成符合规范的客户端 SDK、服务器端代码或文档，而无需手动编写固定格式的代码。 主流 OpenAPI 代码生成工具 以下是几款流行的 OpenAPI 代码生成工具的简要介绍： OpenAPI Generator OpenAPI 生成器允许在给定 OpenAPI 规范（支持 2.0 SDK（使用 OpenAPI（以前称为 Swagger）规范定义）来简化您的构建过程，以便您的团队可以更好地专注于 API 的实施和采用。 选择 OpenAPI 代码生成工具时，可以从以下几个方面入手： 语言支持: 根据项目使用的编程语言选择支持相应语言的工具。
1.6K107编辑于 2025-01-04- 来自专栏Java Web
Java 8——行为参数化
Java 8中新增的功能是自Java 1.0发布以来18年以来，发生变化最大的一次。 （1）用行为参数化把代码传递给方法 Java 8中增加了通过API来传递代码的能力，但这实在听起来太绕了，这到底在说什么！ 在Java 8中，这样做起来（不止于匿名类）远远比你想象的要来得更加清晰、简洁。 这就是行为参数化：让方法接受多种行为（或战略）作为参数，并在内部使用，完成不同的行为。 你现在在灵活性和简洁性之间找到了最佳平衡点，这在Java 8之前是不可能做到的！
1.2K70发布于 2018-04-26 - 来自专栏linux commands
【Python】8“函数的参数“
位置参数 按函数参数顺序传入参数，这样的参数就叫做位置参数。Java的函数中，规定调用者必须按形式参数顺序依次传入参数，这样也可以看做是位置。 return sum ... >>> calc(1,2,3) 14 >>> calc(2,4,6,8) 120 如果需要传入list或者tuple：在list或者tuple前面加上* >>> list 关键字参数 关键字参数允许调用者传入0个或者任意个含参数名的参数，这些关键字参数在函数内部自动组装为一个dict。 在Python中定义函数，可以用必选参数、默认参数、可变参数、关键字参数和命名关键字参数，这5种参数都可以组合使用。 但是请注意，参数定义的顺序必须是：必选参数、默认参数、可变参数、命名关键字参数和关键字参数。
58820发布于 2021-08-12 - 来自专栏cloudskyme
跟我一起云计算（6）——openAPI
供第三方开发者使用，这种行为就叫做开放网站的API，所开放的API就被称作OpenAPI（开放API）。 WebQQ开放平台等） 3、360安全中心（360应用开放平台、360软件开放平台、极速浏览器应用开放平台等） 4、新浪（新浪微博开放平台、SAE） 5、人人网开放平台 6、一苡网开放平台 7、淘宝开放平台 8、 从图中可以看出，人人网开放平台大概分为三个层次，共同为最上层的各种形式的第三方应用程序提供服务： Core Service Layer： 实现了人人网对外提供的最底层的API，定义好了接口参数和调用流程 各个Rest API的接口参数定义详见Rest API。 ，应用编程接口）开放出去，供第三方开发者使用，这种行为就叫做开放网站的API，所开放的API就被称作OpenAPI（开放API）。
3.4K40发布于 2018-03-20 - 来自专栏程序猿DD
OpenAPI 规范 3.1.0 发布，赶紧来尝尝鲜！
除了Spring Boot，OpenAPI也在近日正式发布了其最新的3.1.0版本规范。 OpenAPI 规范是用于描述 API 的行业标准，它允许开发人员和计算机在不需要访问源代码、文档或网络流量的情况下理解 API 的功能。 规范扩展的x-oai和x-oas前缀现在都保留由OpenAPI进行定义。 一些解释内容 路径参数值不能包含未转义的字符/，？或#。 进一步解释应该在何处使用引用对象和JSON模式的引用。 进一步更新了Schema对象的描述，以考虑最新的draft和默认使用https://spec.openapi.org/oas/3.1/dialect/base作为OAS方言。 具体内容可查看：https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0 看完更新内容，小伙伴们是不是蠢蠢欲动，迫不及待体验最新版本的变化呢
2.2K20编辑于 2023-04-04 - 来自专栏草根专栏
使用 OAS（OpenAPI标准）来描述 Web API
而OAS (OpenAPI Specification)是一个与编程语言无关的REST API描述格式. 它是由 OAI (OpenAPI Initiative) 所提倡的. 但是我更习惯于本地编辑器, 我使用VSCode, 并安装 Swagger Viewer 和 openapi-lint 两个插件. ? 注意, 这里第1行 openapi下面的波浪线表示文档验证失败. 在OAS文档里, 一个操作必须在responses属性里提供至少一个响应: ? 使用OpenAPI 和 JSON Schema 来描述 API 的数据 OAS 依赖于 JSON Schema 标准来对所有的数据(查询参数, body 参数, 响应body等)进行描述. 描述 body 参数 像 POST 这样的 Action, 它的参数是在请求的body里面. body参数需要使用 requestBody属性描述, 看代码: ?
4K20发布于 2020-02-18 - 来自专栏Rust语言学习交流
【大家的项目】Poem-openapi
注意：Poem-openapi只支持Poem，所以你如果希望使用它，Poem是必要的依赖，而且我不会考虑支持其它的web框架。 据我所知这是Rust语言里第一个用过程宏来实现OpenAPI规范的库，它的工作方式和Async-graphql非常的像，以类型安全的代码来编写符合OpenAPI规范的API并自动生成文档。 所有API宏描述的操作都会自动生成OpenAPI 3.0规范的文档，你可以clone仓库 https://github.com/poem-web/poem-openapi ，然后执行cargo run use std::collections::HashMap; use poem_openapi::{payload::Json, types::Password, OpenAPI, Response, https://github.com/poem-web/poem-openapi
1.5K30发布于 2021-09-08 - 来自专栏Java面试教程
微信开发之openApi管理
容我想想 了不起：哈哈，那还是我来给你讲一讲微信openApi管理吧！ 正文： 今天了不起就通过三方面讲一下api管理。 1.查询Api调用额度： 官方网址：https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getApiQuota.html 第一个参数就是调用接口凭证，第二个参数就是接口请求地址。出参包含：上面我所说的可查询到的信息。 举例：假设我们要查询获取accessToken接口的api调用额度。 我们cgi_path就要传/cgi-bin/token（这个参数不需要传域名，同时第一个/也不要遗漏了） 错误示例：如果我们cgi_path传的不对，那么接口就会返回76021，msg是cgi_path 出参包含：发送请求的耗时，时间戳，地址，请求参数,请求ip 通过这三个接口，我们就可以我们就可以做到查询接口调用次数，如果接口调用次数即将超过上限，我们就可以调用重置api，以防某些报错。
1.2K10编辑于 2023-09-06 - 来自专栏编程从踩坑到跳坑
JAVA 8 反射获取参数名
前言 在JDK8之前javac编译是不会把构造器和方法的参数名编译进class中，如果需要获取参数名，可以在方法上加上注解，反射获取注解的值从而获取参数名，比如Jackson的@JsonCreator 而JDK8新增了这一个功能，可以直接调用java.lang.reflect.Parameter.getName()获取到，前提是javac需要添加-parameters这个参数。 : false 可以看出Parameter name全都是arg0~argN，因为参数名在编译期已经丢失了。Is name present为false。 /source> <target>8</target> <compilerArgument>-parameters</compilerArgument : false 这样就把参数名给打印出来了，Is name present为true。
1.6K10发布于 2019-12-20 - 来自专栏DotNet NB && CloudNative
体验 dotnet 9 中的 OpenAPI 支持
体验 dotnet 9 中的 OpenAPI 支持 Intro asp.net 9 中引入了生成 OpenAPI 文档的支持，来体验一下 Get Started 首先我们需要添加对 Microsoft.AspNetCore.OpenApi 添加 AddOpenApi() 来注册需要的服务，添加 MapOpenApi() 来注册获取 OpenAPI 文档的 endpoint，这样我们就可以访问默认的 /openapi/v1 来查看生成的 OpenAPI 文档了，访问 /openapi/v1.json 应该就可以看到类似下面这样的输出 openapi OpenAPI UI 生成了 OpenAPI 文档之后，我们可以借助 Swagger UI 框架来根据 openapi 文档来显式 OpenAPI 调试界面，我们可以使用原有的 UI 框架，指定好新的 /openapi/v1.json 路径即可 比如说我们使用原来的 Swashbuckle /customize-openapi?
79310编辑于 2024-12-23 - 来自专栏chester技术分享
.NET7 gRPC JSON转码+OpenAPI
OpenAPI与gRPC Server OpenAPI（以前称为 Swagger）是一个与语言无关的规范，用于描述 API。 gRPC JSON 转码支持从转码 REST ful的 API 生成 OpenAPI。 PackageReference Include="Microsoft.AspNetCore.Grpc.Swagger" Version="0.3.0" /> </ItemGroup> 为api生成用于OpenAPI
1.6K10编辑于 2022-12-19
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号