首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

还在手动维护API文档吗?是时候用用丝袜哥(swagger)了!

Swagger是一个简单但功能强大的API表达工具。它具有地球上最大的API工具生态系统,数以千计的开发人员,使用几乎所有的现代编程语言,都在支持和使用Swagger。...使用Swagger生成API,我们可以得到交互式文档,自动生成代码的SDK以及API的发现特性等。 来体验一把吧!...Swagger 使用swagger能帮我们生成API文档,那么它会生成什么样的API文档呢?...OpenAPI OpenAPI规范是Linux基金会的一个项目,试图通过定义一种用来描述API格式或API定义的语言,来规范RESTful服务开发过程。...这种是先写文档再出代码,代码里会自动生成一些注解。 but,如果丝袜哥只提供这个,那就太差点意思了,需要自己编写文档,而且yml格式的东西,一不注意多个空格就会报错,还是没有解放我编写文档的双手!

1.2K10
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    这些年我用过的API文档工具,个个是精品!

    Swagger Swagger是一款非常流行的API文档工具,它能帮助你简化API文档的开发,极大提高开发效率,之前在mall项目中就是使用的它。...我们一般将Swagger和SpringBoot结合使用,使用的是Springfox给我们提供的工具。使用该工具可以根据注解自动生成API文档,并且可以在生成的文档上进行接口调试。...如果你的项目是微服务项目的话,使用Knife4j可以聚合所有服务的文档,具体使用可以参考《微服务聚合Swagger文档,这波操作是真的香!》 。...Apifox 的定位是Postman + Swagger + Mock + JMeter,具有API文档管理、API调试、API Mock、API 自动化测试等功能。...官方网站:https://www.apifox.cn/ 总结 本文整理了之前使用过的7种API文档生成+管理工具,如果你是刚开始使用API文档工具的话,使用Swagger准没错!

    1.5K30

    一款零注解侵入的 API 文档生成工具,你用过吗?

    介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念,完全基于接口源码来分析生成接口文档...你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文档。...支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 开放文档数据,可自由实现接入文档管理系统。...支持导出错误码和定义在代码中的各种字典码到接口文档。 支持Maven、Gradle插件式轻松集成。 支持Apache Dubbo RPC接口文档生成。...当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的,也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。

    68030

    一款零注解侵入的 API 文档生成工具,你用过吗?

    一款零注解侵入的 API 文档生成工具 介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA...泛型定义推导的理念,完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。...你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文档。...支持导出错误码和定义在代码中的各种字典码到接口文档。 支持Maven、Gradle插件式轻松集成。 支持Apache Dubbo RPC接口文档生成。...当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的,也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。 ---- 效果示例 1.

    1.6K20

    数据库的AI到底是真的吗?

    腾讯云数据库国产数据库专题线上技术沙龙已圆满结束,本期带来邢家树分享的《CDB Tune:腾讯云数据库的AI技术实践》直播视频和文字回顾。...关注“腾讯云数据库”公众号,回复“0530邢家树”,即可下载直播分享PPT。 大家好,我是邢家树,今天和大家分享的主题是CDBTune,腾讯云数据库的AI技术实践。...我们首先来看一下智能参数调优的背景。数据库是许多应用和业务的关键一环,也是数据产生、存储和利用的一个核心组件。...另外数据库的状态(性能指标)和它的动作空间(参数配置的组合)是非常大的,组合一张Q-Table出来基本上是不可能的任务。这个时候怎么办呢,这个时候DQN就派上用场了。...这个模型的特点,第一个是解决了状态空间大的问题,这个其实也比较好理解,假设我数据库,描述我这个数据库状态有63个指标,那就有63种维度。

    1.1K40

    1k Star国产前后端完全开源的在线文档工具、API、WIKI、数据库文档!

    项目介绍 zyplayer-doc是一款前后端完全开源的在线文档工具,现有API接口文档(Swagger、OpenApi、自建接口)、WIKI文档、数据库文档(数据库表结构查看管理、SQL执行)。...集成了本项目内的各个子模块功能,是各模块的协调管理模块。...目标是取代Navicat,做一个小而精的开源免费的在线数据库管理工具。...zyplayer-doc-api API接口文档管理工具 一款支持统一管理Swagger文档、OpenApi文档、自建接口文档的管理工具,具有文档查看、接口请求、全局参数管理等功能,设计走心,前端代码使用最新技术构建...一些测试 界面展示 控制台页面 数据库文档页面 WIKI文档页面 API文档主页面 API文档查看页面 API文档在线调试页面 地址:https://gitee.com/zyplayer/

    1.6K40

    伸手党福利-从零开始玩转图库

    > ourist过程用到的数据库,可视化展示如下: ?...30)).values('name') //7 ==>josh gremlin查询语法就不在此赘述了,请查阅官网文档。...core api(api for OLTP) 图库的curd操作,包括traveral,追求低延时,高吞吐,尽量少的慢查询。...我们关注下OLTP方面,主要有api层,实现tinkpop api,底层storage api,这些是跟hbase/solr等打交道的,比较重要的工作在于database逻辑层,包括事务, 数据管理(节点...众所周知搜索引擎使用全文搜索的技术,本质上是term->document倒排索引,如下query ”XX明星的老婆的弟弟的舅舅的儿子叫什么“ 使用全文搜索方式完全丧失了答案的正确性,使用图数据库轻而易举能得到正确答案

    4.9K30

    3. JanusGraph快速开始

    Gremlin Console是在JanusGraph包中自带的一个REPL(即交互式的shell),这跟标准的Gremlin Console有所不同,因为它是JanusGraph预安装和预加载的包。...Groovy构建在Java语言之上,具有很多简洁的语法,使交互式编程变得更加容易。同样的,Gremlin-Groovy也是构建在Groovy之上,具有简洁的语法,使得图的遍历变得容易。...本节将暂时跳过这些详细的配置信息,但有关数据库,索引及其他的配置信息,请参见第III部分“数据库”,第IV部分,“索引”和第15章“配置参考”。...() ==>graphtraversalsource[standardjanusgraph[cql:[127.0.0.1]], standard] 全局图索引 使用图数据库中数据的典型模式是首先使用图索引来确定起始点...以顶点为中心的索引将在后续中讲解。 图遍历示例 Hercules是Jupiter和Alcmene的儿子,拥有超能力。Hercules是一个半神半人,因为他的爸爸是神他的妈妈是人类。

    3.3K20

    图数据库调研

    另外,Neo4j 的数据组织是属性图的。 Gremlin:查询的图本质仍然是一张一张的表,因此处理数据、管理数据相对简单一些。...Microsoft Azure Cosmos DB Cosmos DB是微软2010年立项,经过7年研发,于2017年5月正式发布的云数据库服务,该数据库服务支持图数据、列存储、键值存储和文档数据库等多种数据模型...Cosmos DB 的优势: 全球部部署 多数据模型+API 提供了五种数据一致性(参考这里) 弹性存储拓展 … Amazon Neptune 2017年11月底,亚马逊在 AWS 2017全球峰会发布了全新的图数据库产品...Amazon Neptune 支持 Gremlin 和 SPARQL 的开放图谱 API,并为这些图形模型及其查询语言提供高性能。...可以 JSON 格式导入、导出文档。 HugeGraph HugeGraph 是一款面向分析型,支持批量操作的图数据库系统,它能够与大数据平台无缝集成,有效解决海量图数据的存储、查询和关联分析需求。

    6.6K30

    如何为微服务选择数据库

    DSE在核心模型之上构建对应的键值和文档模型也是很简单的,如下图所示。...图:对于象服务D那样相关度很高的数据,DSE的图是一个高度可扩展的图形数据库,它构建于DSE数据库之上。...DSE图支持来自Apache tinkerpop项目中强大的功能和表现力的Gremlin API。...在选择多模型数据库时要考虑的一个问题是如何支持各种模型。一种常见的方法,是基于单一的原生的基础模型的数据库引擎,而其他模型都是构建在其之上。分层数据模型更能展现底层基本模型的特性。...用Tabular(例如DSE数据库)作为网络水平的可扩展性和可用性的主要模型,然后根据需要在此之上构建分层的键值对和文档数据模型。

    1.5K100

    知识图谱之图数据库如何选型:知识图谱存储与图数据库总结、主流图数据库对比(JanusGraph、HugeGraph、Neo4j、Dgraph、NebulaGraph、Tugrapg)

    OrientDB 虽然支持图、文档、键值、对象、关系等多种数据模型, 但其底层实现主要面向图和文档数据存储管理的需求设计。...Cayley 使用 Go 语言开发,可以作为 Go 类库使用;对外提供 REST API,具有内置的查询编辑器和可视化界面;支持多种查询语言,包括:基于 Gremlin 的 Gizmo、GraphQL...此类图数据库在现有存储系统之上新增了通用的图语义解释层,图语义层提供了图遍历的能力,但是受到存储层或者架构限制,不支持完整的计算下推,多跳遍历的性能较差,很难满足 OLTP(on-line transaction.../ 原生图存储 Cypher 是 JanusGraph 开源 属性图分布式存储 Gremlin 分布式图数据库, 存储后端与查询引擎分离, 实现了 Gremlin OrientDB 商业 属性图 /...API (2) NebulaGraph NebulaGraph 是一个分布式,可扩展且闪电般的图形数据库。

    5.3K11

    查询图数据库的新ISO标准GQL

    Neo4j 的首席技术官 Philip Rathle 在接受 TNS 采访时表示:“没有什么是像国际正式标准这样的,它与 SQL 来自同一组织,是 SQL 的兄弟,可以为 GQL 的主流价值大肆宣传。”...图计算的基础是属性图,它在描述动态变化的数据方面更胜一筹。 图数据库已广泛使用了几十年,直到最近,该形式才引起了人们对成为关键组件的新兴趣大型语言模型的生成式 AI 应用程序。...其他图查询语言包括NebulaGraph 的 NQL,Apache Tinkerpop 的 Gremlin,RDF 的 SPARQL 以及 ArangoDB 的 AQL 。...还有 GraphQL 语言,这是一种面向图的查询语言,用于构建 API。 从现有的图查询语言升级的路径应该相当容易,至少如果这些实现基于 Cypher 的话。...据 Rathlee 称,至少有十几个不同的图数据库系统建立在 OpenCypher 之上,包括来自 Amazon Web Services 的流行的 Neptune。

    30710

    图数据库查询语言Cypher、Gremlin和SPARQL

    各自优化的目标可能不一样,一般的实现大多是聚集于自家的API,对于相对通用的Gremlin和SPARQL的支持可能只是有而已,功能支持少缺胳膊少腿,各种让人难受。...用SQL查询是需要对表设计有一些要求的,同样的Gremlin和SPARQL两种查询标准都是对存储模式是有一定假设(或者要求)的。...2.3 Gremlin Gremlin是由Groovy实现的图查询语言,查询过程就是图遍历的过程。...问题1:这些不能用SQL实现吗? 答:这里涉及到一个问题,属性值并不总是单一值(List),而SQL表是有这个假设的(比如MySQL,PostgreSQL是有Array类型的)。...用Gremlin和SPARQL可以很容易地从某个数据库转到另外一个,但是Cypher就不要想了。另外,Neo4j的数据组织是属性图的。 问题5:MongoDB和ElasticSearch呢?

    4.2K50

    属性图数据库JanusGraph初探

    1.1 Tinkerpop结构 Tinkerpop处理是图结构的数据,它的结构API的基础组件包括如下几部分: Graph:维护点和边的集合,数据库访问如事务; Element:维护属性和标签(表示元素的类型...当一个图系统实现的TinkerPop3的结构和处理API,则该系统是支持TinkerPop3的并且跟其他支持TinkerPop3的图系统在时间复杂度和空间复杂度是没有区别的。...图2.2 Tinkerpop 系统框架 TinkerPop是由多个可共同操作的组件组成的架构。Core TinkerPop3 API是整个架构的基础,它定义了什么是点、边和属性。...一个图系统至少要实现Core API。一旦实现,就可在系统中是有Gremlin遍历语言。...一旦实现,Gremlin遍历可以在图数据库(OLTP)和图处理器(OLAP)上执行。然而,Gremlin语言是基于图的领域特定语言,根据点和边来解释图。用户也可以创建自己的领域特定语言。

    3.6K50

    extremedb是开源的吗_最简单的数据库开发软件

    最近我接触了嵌入式数据库eXtremeDB,由于这方面资料很少,网上的参考资料都大同小异,只靠着软件本身提供的参考文档进行开发,所以刚开始开发有些困难。故将基本的用法整理一下。...mco文件里面需要定义数据库所需的字段类型,名称等,里面可以定义结构体,矢量等。...3)如果该数据库代码是运行到嵌入式开发板上的,还需要在项目中添加extremeDB的.a文件,即extremeDB文件下的/target/bin/PENTIUM4gnu/下的.a文件 4.根据需求进行数据库开发...1) 初始化数据库:主要对数据库进行相关配置并建立连接,其中涉及到的函数如下: mco_db_params_init() //对参数按照默认值进行初始化 mco_db_open_dev()...Msg_new() //新建数据库元素,Msg是上面定义的数据库表名 Msg_testState_put() //将数据放入到指定元素汇总 Msg_acSpeed_alloc

    99830

    JanusGraph图数据库的应用以及知识图谱技术介绍

    参考文档:JanusGraph 架构概览 JanusGraph 架构可以利用分布式技术和横向扩展能力实现高性能的图数据库操作。它专注于紧凑的图序列化、丰富的图数据建模和高效的查询执行。...Janus与图数据库相关概念 图数据库基本特点 图数据库是源于欧拉和图理论的一种非关系型数据库,其基本特征是以"图"这种数据结构存储和查询数据。...Gremlin API: JanusGraph引入了Apache TinkerPop Gremlin组件,通过Gremlin API提供了开源标准的图交互式查询语言接口。...REST API: JanusGraph提供了REST API,包含了完整的图查询、修改、删除和管理接口。...通过REST API,用户可以通过HTTP协议与JanusGraph进行通信,实现图数据库的各项操作。 4.

    45510

    超详细的大数据学习资源推荐(上)

    Data:是一个开源的大规模可扩展的数据存储,需要零管理模式; Facebook Apollo:Facebook的Paxos算法,类似于NoSQL数据库; jumboDB:基于Hadoop的面向文档的数据存储...; LinkedIn Espresso:可横向扩展的面向文档的NoSQL数据存储; MarkLogic:模式不可知的企业版NoSQL数据库技术; MongoDB:面向文档的数据库系统;...RavenDB:一个事务性的,开源文档数据库; RethinkDB:支持连接查询和群组依据等查询的文档型数据库。...:开源图形数据库; Google Pregel :图形处理框架; GraphLab PowerGraph:核心C ++ GraphLab API和建立在GraphLab API之上的高性能机器学习和数据挖掘工具包的集合...; FoundationDB:由F1授意的分布式数据库; Google F1:建立在Spanner上的分布式SQL数据库; Google Spanner:全球性的分布式半关系型数据库;

    2.2K80

    图查询语言的历史回顾短文

    这群人开发了一个 Java API 来和这种数据模型交互,并在关系型数据库之上实现了一个抽象层。 虽然这种网络模型极大的提高了生产力,但是性能一直很差。...Gremlin 的创造 最初与 Neo4j 的查询方式是通过 Java API。应用程序可以将查询引擎作为库嵌入到应用程序中,然后使用 API 查询图。...如果是自定义查询引擎,然后应用程序远程访问服务器,这样就比较困难。 就在这段时间,NOSQL 这个概念开始出现。NOSQL 型的数据库引擎一般用 REST 和 HTTP 来交互和查询。...Cypher 的创造 Gremlin 和 Neo4j 的 Java API 一样,最初用于表达如何查询数据库的一种过程(Procedural)。...它允许更短的语法来表达查询,也允许通过网络远程访问数据库。Gremlin 这种过程式的特性,需要用户知道如何采用最好的办法查询结果,这样对于应用程序开发人员来说仍旧有负担。

    2.8K20
    领券