参考如下:
1. http://apidocjs.com/
2. http://www.bjhee.com/apidoc.html
3. https://cloud.tencent.com/developer/article/1005271
4. http://hinylover.space/2016/03/31/create-online-document-use-apidoc/
5. https://fxm5547.com/%E6%8A%80%E6%9C%AF%E8%A7%84%E8%8C%83/2017/11/08/apiDoc-define-standard/
6. https://www.jianshu.com/p/a799c23234b8
7. https://blog.csdn.net/weixin_40475396/article/details/80352744
简单的配置如下:( Django )
1. 安装apidoc,
写道
npm install apidoc -g
2. 按apidoc语法写好文档,参考5是一篇very good的语法规范
3. 生成apidoc文档,我这里是放在项目根目录下的static文件夹的apidoc目录
先在项目根目录下放一个apidoc.json文件,示例如下:
{ "name": "测试", "version": "0.0.1", "description": "API文档测试", "title": "API文档测试", "url" : "http://xxxxxxx", "sampleUrl" : "http://xxxxxxxx", "template":{ "forceLanguage":"zh_cn" } }
写道
apidoc -i 你的文档代码路径 -o static/apidoc
4. 修改 settings.py , 添加下面代码
STATIC_ROOT = os.path.join(BASE_DIR, 'static') APIDOC_ROOT = os.path.join(STATIC_ROOT, 'apidoc')
5. 修改 urls.py , 添加下面代码
from django.views.static import serve from django.conf import settings urlpatterns = [ url(r'^apidoc/(?P<path>.*)$', serve, {'document_root': settings.APIDOC_ROOT}), .... ]
6. 运行runserver , localhost:8000/apidoc/index.html 试试看吧!
相关推荐
自动生成代码,包括apidoc接口文档
APIDOC 生成 RestFul 接口文档模板。apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具,它几乎支持目前主流的所有风格的注释。
laravel-apidoc-generator, Laravel API文档生成器 Laravel API文档生成器自动从现有的Laravel 路由生成你的API文档。 让我们看一下示例文档。php artisan api:gen --routePrefix="settings/api/*
没有任何参数,apiDoc 从当前目录(包括子目录)中的所有 .cs .dart .erl .go .java .js .php .py .rb .ts 文件生成文档并将输出写入 ./doc/。 apiDoc 包含一个默认模板,它使用把手、Bootstrap、RequireJS 和 ...
Laravel API文档生成器从现有的Laravel / Lumen / 路线自动生成API文档。 php artisan apidoc:generate安装需要PHP 7.2和Laravel / Lumen 5.7或更高版本。 如果您的应用程序不满足这些要求,则可以签出3.x分支以获取...
使用apidoc时生成文档时需要 3 步(默认使用者已经安装了node.js、apidoc,如果没有可以根据这个来完成:,v6版本的node.js安装后会把npm也装好, )完成api的注释文档;完成(这一步可省略);使用命令 ,在哪个...
apidoc 自动生成APIweb文档demo
HTML文档将在注释和保存时从源PHP文件自动生成。 可以在浏览器中查看生成的文档: 对受监视源文件的任何更改将自动重建文档并重新加载浏览器。 生成的文档的示例可以在。 安装 确保在系统上安装了Node,并确保...
APiDoc的作用是根据定义好的API接口和注释来自动生成给内部开发者提供的API对接文档。 Nuget下载 Install-Package AspnetCoreApiDoc 关于ProtoBuffer 官方描述: Protocol buffers are a language-neutral, platform...
根据Ext JS的源码,自动生成API文档。适用在Ext JS 的共用模块和包中。 1. jsduck-5.3.4 是发布的最新稳定版本, 最新版是jsduck-6.0.0-beta 2. 该工具自2013/12之后就没有再更新, 但是截止2020依旧可以使用 3. ...
“ setupdocx”通过简化文档的创建,打包和安装,为连续文档提供了一个控制层。 提供的命令作为入口点和可选的基类分发,以进一步自定义为“ ... -build_apidoc-API文档的独立生成器-build_apiref-API参考的独立生成器
保存时自动使用 生成对应格式的 HTML 页面。 Demo: Install 项目使用 Node.js 编写,使用 Express 框架。 npm install npm start Other 正在学习 Node.js,写的不好的地方求各位不吝赐教,期待 PR~!
前后台分离时,api文档自动生成插件的前端页面,采用angular实现。 开发环境 Angular CLI: 1.7.4 Node: 8.4.0 OS: win32 x64 Angular: 5.2.10 快速启动 下载该项目然后npm install 如果网络受限,请尝试淘宝的镜像 ...
java的HTTP API文档生成中间件Swagger使用教程.zip 用JAVA开发动静分离的网站,后端要编写API文档简直太容易不过了,用上SWAGGER基本就是全自动生成API DOC了.
Wisdom rest-client 一款自动化测试REST API的工具,它可以自动化测试REST API并生成精美的测试报告,同时基于测试过的历史数据,可以生成精美的REST API文档。 How it works 1. Download JAR: ; 下载JAR包, 如果...
foreman目录cp -r TEMPLATE XY ln -sf XY latest cp -r dir/to/foreman/public/apipie-cache/apidoc/* YY/apidoc 在apidoc仓库中运行清理脚本: cleanup.sh执照所有文件都是在GNU GPL v3条件下自动生成和分发的。...
@eropple/nestjs-openapi3是一个图书馆产生从您的API规范文档。 与相比,它试图与您的应用程序流更加集成,并推动您构建干净,分隔良好的API。 发行历史 0.4.4 添加了OAS.propPrefabs ,其中包括一些有用的预设,...
根据程序逻辑自动生成laravel curd程序,生成的程序支持laravel-smart-apidoc生成文档。 ###安装方法 命令行执行: composer require --dev rockyfc/laravel-smart-gii 注:只在开发环境安装即可。 在命令行执行...
i ./ -o apidoc/ 其中 -i ./ 指定要生成文档的目标文件,-o apidoc/ 指定要生成文档的输出路径</p><p>wk-nb-web-admin 目录下,执行 apidoc -i ./ -o E:/dst/apidoc_admin/ 生成后台接口文档</p><p>wk-nb-web-api-open...