prmd:用于HTTP API的JSON模式工具和文档生成

时间:2024-03-18 06:03:25
【文件属性】:

文件名称:prmd:用于HTTP API的JSON模式工具和文档生成

文件大小:70KB

文件格式:ZIP

更新时间:2024-03-18 06:03:25

Ruby

prmd JSON Schema工具:从JSON Schema文档中搭建,验证并生成文档。 介绍 提供了一种描述API的好方法。 prmd提供了用于引导这样的描述,验证其完整性以及根据规范生成文档的工具。 要总体上了解有关JSON Schema的更多信息,请从开始并补充。 通过PRMD预期的JSON架构使用约定具体描述在 。 安装 使用以下命令安装命令行工具: $ gem install prmd 如果在Ruby项目中使用prmd,则可能需要将其添加到应用程序的Gemfile中: gem 'prmd' $ bundle install 用法 Prmd提供了四个主要命令: init :脚手架资源模式 combine : combine模式和元数据合并到单个模式中 verify :验证架构 doc :从架构生成文档 render :从架构渲染视图 这是在典型的工作流程中使用这些命


【文件预览】:
prmd-master
----lib()
--------prmd()
--------prmd.rb(304B)
----Gemfile(89B)
----Rakefile(138B)
----schemas()
--------schema.json(4KB)
--------hyper-schema.json(5KB)
--------interagent-hyper-schema.json(5KB)
----CONTRIBUTING.md(873B)
----.travis.yml(180B)
----test()
--------helpers.rb(4KB)
--------utils_test.rb(582B)
--------commands()
--------core()
--------schema_test.rb(1KB)
--------cli()
--------link_test.rb(1KB)
--------schemata()
--------multi_loader()
--------rake_tasks()
----LICENSE.md(1KB)
----prmd.gemspec(1022B)
----README.md(5KB)
----docs()
--------schemata.md(8KB)
----CONTRIBUTORS.md(2KB)
----.gitignore(186B)
----bin()
--------prmd(160B)

网友评论