V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐关注
Meteor
JSLint - a JavaScript code quality tool
jsFiddle
D3.js
WebStorm
推荐书目
JavaScript 权威指南第 5 版
Closure: The Definitive Guide
yycf
V2EX  ›  JavaScript

想做个在线 api 文档的网站, 大家给点建议呗

  •  
  •   yycf · 2019-11-01 10:35:46 +08:00 · 4346 次点击
    这是一个创建于 1857 天前的主题,其中的信息可能已经有所发展或是发生改变。

    本人前端,和后端合作是发现文档的共享是个问题,暂时没有发现好用的在线文档, 打算自己写一个, 可以显示出有哪些接口改动了的网站。想征集下大家的 api 文档都是用什么写的, 有好用的网站参考下吗, 或者可以看看一个接口是怎样的格式给小弟参考下?

    11 条回复    2019-11-01 16:54:20 +08:00
    onion83
        1
    onion83  
       2019-11-01 10:43:33 +08:00
    这个行当已经非常成熟了

    https://apizza.net
    https://www.eolinker.com
    Vegetable
        2
    Vegetable  
       2019-11-01 10:45:21 +08:00
    di1012
        3
    di1012  
       2019-11-01 10:59:33 +08:00
    swagger
    Roccc
        4
    Roccc  
       2019-11-01 12:20:10 +08:00
    unicloud
        5
    unicloud  
       2019-11-01 13:30:14 +08:00 via iPhone
    市面上很多,稍微搜一下就知道了
    yycf
        6
    yycf  
    OP
       2019-11-01 14:14:00 +08:00
    @onion83 多谢, 确实好用。 是我之前没找到
    star7th
        7
    star7th  
       2019-11-01 15:49:04 +08:00
    标准的文档示例参考 www.showdoc.cc/demo?page_id=10
    wangyzj
        8
    wangyzj  
       2019-11-01 15:50:35 +08:00
    gitjavascript
        9
    gitjavascript  
       2019-11-01 15:57:02 +08:00
    居然有这个想法
    FaceBug
        10
    FaceBug  
       2019-11-01 15:59:35 +08:00
    以前 eolinker.com 还有开源的,好像现在没了
    iYoloyolo
        11
    iYoloyolo  
       2019-11-01 16:54:20 +08:00
    我司 apidoc
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2578 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 06:16 · PVG 14:16 · LAX 22:16 · JFK 01:16
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.