首页
学习
活动
专区
圈层
工具
发布
    • 综合排序
    • 最热优先
    • 最新优先
    时间不限
  • 来自专栏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描述文件自动生成客户端

    96110编辑于 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
  • 来自专栏python入门

    Python入门11 函数参数

    我们来看之前这个函数的书写形式:ret()为什么函数后面要加括号呢,是因为括号内是预留给参数的位置,当没有参数的时候,括号内为空,当需要参数的时候,情况就不同了【函数参数】以下是一个使用函数参数的例子: ,根据name的不同,它会打印不同的结果接受参数使得函数拥有了更大的灵活性,这就是参数的作用一个函数也可以接受多个参数参数之间用逗号隔开在函数的参数传递过程中,有两个比较抽象的概念:形式参数和实际参数 【形式参数】在函数定义阶段括号内所填写的参数,简称"形参"def func(a, b): passa和b就是函数func的形参【实际参数】在函数调用阶段括号内传入的参数,简称"实参"func(1,2 (3,5)可以看到minus(5,3)和minus(3,5)运行的结果是不一样的因为a,b有先后顺序【关键字参数】有时,为了避免位置参数赋值带来的混乱,python提供使用参数名赋值的方式# coding 5)add(5,2)当运行add(5)时,b取默认值0,a+b=5+0=5当运行add(5,2)时,b的值被覆盖为2,a+b=5+2=7默认参数值使得函数的使用更加灵活※注意,有默认值的参数要放在无默认值参数的后面

    29310编辑于 2024-05-09
  • 来自专栏泛泛聊后端

    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 中来验证你的 OpenAPI 文件是否符合规范,以下我们就主要介绍 8 个根对象的使用和扩展方法 openapi 对象 openapi 是最简单也是最基础的属性,我们为 OpenAPI 添加第一个根对象属性 ,指定使用的规范版本: openapi: "3.0.2" 然后继续补充信息 openapi: "3.0.2" info: title: openAPI Demo version: '1.0' ,描述如下,( requestBody 描述不在此列包含系列属) name:参数名称 in:参数出现的位置,通常是 header,path,query,cookie description:参数的描述( 支持 markdown) required:必填项 deprecated:是否弃用 allowEmptyValue:允许提交空值 style:参数序列化方式 explode:与数组相关的参数 schema

    15.6K31编辑于 2022-11-11
  • 来自专栏全栈程序员必看

    openwrt外网web管理_OpenAPI

    debug 当您使用带 debug 参数的 URL,应用程序将不会执行串联所有 minification的 JavaScript 文件这个过程。 将传入一个名为instance的参数,这个参数代表当前 OpenERP 的 Web 客户端实例, 包含了所有相关当前会话数据,以及所有 Web 模块的变量。 $el 当你在部件中重载init()时,必须以父部件作为第一参数传入,并调用传入给this. Widget.trigger(event_name [ , …]) 方法的第一个参数是待触发的事件名,也接受任何数量的其他参数。这些参数将被传递到所有的事件侦听器。 当func被调用时,trigger()的其他参数会传递给它。

    7.2K10编辑于 2022-11-17
  • 来自专栏数据库学习笔记

    参数优化】11gR2安装后参数优化

    以下为11gR2安装完成后需要优化的参数,建议PC端查看。 前序: 【安装】CentOS7.7下图形化安装Oracle11gR2 【补丁】Oracle11gR2补丁更新(PSU) 一、参数优化 #如果指定为TRUE, 并行操作只会在当前instance里面并行 但是该参数存在不稳定因素,可能会带来执行效率的问题,建议关闭优化器反馈。 11R2会遇到一个BLOOM过滤器导致的BUG 9124206和BUG 8361126,出现ORA-00060 ORA-10387错误 alter system set "_bloom_filter_enabled ,还是各有区别,部分参数在当前知识体系下还不理解,后续深入学习后再补充修正。

    1.6K30发布于 2021-04-22
  • 来自专栏后台技术汇

    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
  • 来自专栏Linux网络

    【C++11】可变参数模板

    前言: 上文我们学到右值引用及其移动语义,学习到了C++11中对性能提升对重要的更新之一。C++11进阶之路:右值引用和移动语义,让代码跑得更快! -CSDN博客 本文我们来讲讲,C++11的下一个新语法:可变参数模板 1.基本原理 C++11支持可变参数模板。既支持可变参数的函数模板、可变模板参数的类模板。 可变的参数被称为参数包。参数包分为两类:1. 模板参数包:包含零或多个模板参数。 2. 函数参数包:包含零或多个函数参数。 在模板参数中,使用class + ...或typename + ...来表示此时的参数参数包。 在函数参数中,类型名+ ... 表示此时的参数参数包。 Args> iterator emplace (const_iterator position, Args&&... args); emplace是C++11提供的新类成员函数。

    17110编辑于 2026-01-14
  • 来自专栏cloudskyme

    跟我一起云计算(6)——openAPI

    供第三方开发者使用,这种行为就叫做开放网站的API,所开放的API就被称作OpenAPI(开放API)。 软件开放平台、极速浏览器应用开放平台等) 4、新浪(新浪微博开放平台、SAE) 5、人人网开放平台 6、一苡网开放平台 7、淘宝开放平台 8、盛大开放平台 9、金山云安全开放平台 10、搜狐微博开放平台 11 从图中可以看出,人人网开放平台大概分为三个层次,共同为最上层的各种形式的第三方应用程序提供服务: 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) 所提倡的. OAS vs Swagger OAS 原来叫 Swagger Specification, 2015年11月这个格式被贡献给了OAI, 并在2016年1月更名为 OpenAPI Specification 但是我更习惯于本地编辑器, 我使用VSCode, 并安装 Swagger Viewer 和 openapi-lint 两个插件. ? 使用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
  • 来自专栏10km的专栏

    C++11:可变参数模板实现print输出参数

    https://blog.csdn.net/10km/article/details/51226657 C++11支持可变参数模板的特性,真的是很好用。 下面代码实现的print函数,就利用可变参数模板以及函数模板递归调用,实现将任意多个不同类型的参数顺序输出打印到std::ostream流中。 #include <iostream> /* 终止递归函数 */ inline void args_print(std::ostream& steam){} /* 使用可变参数模板实现参数打印到输出流( ;//剩余参数递归调用 }

    2.7K10发布于 2019-05-25
  • 来自专栏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
领券