API-doc 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
API-doc 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票

软件简介

RESTful API 标准文档生成工具,可生成直观的HTML形式、PDF格式的文档,方便API开发者查阅。

1. 遵循OpenAPI规范编写RESTful API的接口定义

2. 生成直观的HTML和PDF格式的文档

3. 对中文的完美支持,解决asciidoctor生成中文时的乱码问题

HTML格式的文档截图:

PDF格式文档截图:

 

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (1)

加载中
文档里面怎么引用图片
2018/02/01 13:36
回复
举报
更多评论
暂无内容
发表了博客
2019/04/28 14:59

[dev] Go语言查看doc与生成API doc

类似与javadoc,go也可以自动生成doc文档。 方法有两个: 1. 使用go doc工具 可以查看它的详细文档: go help doc 示例: 在这个目录下,我创建一个api包 ╰─>$ pwd /home/tong/Src/go/src/local/test/api/api.go 代码是这样的: package api import "fmt" type TestApi struct { var1 int var2 int ...

0
0
发表于开发技能专区
2017/01/22 18:03

PHP_DOC 实时生成 API 文档

随着API的迅速发展,如何编写出更加规范的API文档说明? 这显的尤为重要。 你是否还通过手写的方式来生成和编写这些文档呢? 那么你就OUT啦! 工欲善其事,必先利其器。 本文分享一款工具:PHP_DOC。 在线实时查看...

0
0
发表了博客
2018/08/03 23:39

使用swagger作为restful api的doc文档生成

本文作者:@Ryan Miao 本文链接:https://www.cnblogs.com/woshimrf/p/swagger.html 版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处! 目录 初衷 swagger介绍 在dropwizard中使用 在spring-boot中使用 配置 4.设定访问API doc的路由 6. 设置在生产环境关闭swagger 参考: 初衷...

0
0
发表了博客
2019/04/07 21:36

使用swagger作为restful api的doc文档生成

初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情。也许多点,也许少点。甚至,接口总是需要适应新需求的,修改了,增加了,这份文档维护起来就很困难了。于是发现了swagger,自动生成文档的工具。 swagger介绍 首先,官网这样写的: Swag...

0
0
发表于服务端专区
07/02 06:22

开源API文档工具- swagger2 与 smart-doc 比较 与 使用

工具开源地址 swagger2 : https://swagger.io/ smart-doc: https://www.oschina.net/p/smart-doc 国产 两者的比较 swagger2 和 smart-doc 两个开源工具 都可以 使用jar包 生成 api 文档。 相同点: 这个两个工具......

0
0
发表于程序人生专区
11/14 12:20

早知道这些查询数据的API,我还学什么爬虫啊.doc

后台回复‘0816’,加入Python技术交流群~ 前文回顾:震惊脸!这5个软件难道只有Python程序员才知道吗? 提起Python,最先想到爬虫的请举手~~ 爬虫的重要功能之一就是快速获取数据,比如在网上下载3万条数据,人工...

0
0
2015/10/16 09:04

spring boot之使用springfox swagger展示restful的api doc

springfox swagger展示restful的api doc, swagger is A POWERFUL INTERFACE TO YOUR API.

0
9
发表了博客
2019/03/19 11:39

Go Doc文档

Go为我们提供了快速生成文档和查看文档的工具,很容易编写查看代码文档。在项目协作过程中,可以帮助我们快速理解代码。 <br/> 查看文档方式有两种:一种是通过终端查看,使用go doc命令,一种是通过网页查看,使用godoc命令 <br/> 通过终端查看文档 go doc命令 $ go doc help usage: go doc [-u] [-c] [package|[packag...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
1 评论
54 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部