文件名称:discourse_api_docs:话语API文档
文件大小:185KB
文件格式:ZIP
更新时间:2024-05-29 06:34:57
JavaScript
话语API文档 要查看Discourse API文档,您可以访问: 贡献 欢迎捐款! 首先克隆存储库。 要编辑api文档,请编辑openapi.yml文件而不是json文件。 要在本地查看更改,请运行: npm install node server.js 浏览到以查看漂亮的文档。 在您进行更改或创建PR之前,将yml文件转换为json: node tojson.js 要验证转换为json是否正常工作,请运行: node server.js json 这将直接加载json文件,而不是将yml文件实时转换为json。 现在浏览到并确认您的更改看起来还可以。 然后,您可以提交更改并创建PR。 这是因为我们正在使用github页面托管静态doc网站。 模式生成器 为了帮助在swagger.yml文件中编写yml响应,请使用以下命令将实际的json响应转换为yml模式文件: nod
【文件预览】:
discourse_api_docs-master
----.gitignore(14B)
----openapi.json(389KB)
----favicon.png(3KB)
----package.json(682B)
----tojson.js(548B)
----to_json.rb(432B)
----package-lock.json(33KB)
----definitions()
--------posts()
--------admin()
--------search()
--------categories()
--------users()
--------topics()
--------groups()
--------notifications()
----LICENSE(1KB)
----categories.yml(2KB)
----index-versioned.html(873B)
----postman()
--------discourse_local.postman_environment.json(673B)
--------discourse.postman_collection.json(852KB)
----README.md(1KB)
----openapi.yml(217KB)
----index.html(670B)
----responses()
--------posts()
--------admin()
--------search()
--------categories()
--------users()
--------topics()
--------groups()
--------notifications()
----toschema.js(1KB)
----local.html(630B)
----server.js(1KB)
----CNAME(18B)