FHIR 接口文档美化的评估
Opened this issue · 20 comments
发了一封邮件 征询是否采用swagger 或RAML的接口描述方式以及其接口文档生成的方式来对FHIR现有的REST接口文档进行美化
未果，仍得自己进行评估
效果列表：
1、周末看到Akido创业公司在做医院内部的API 查看他们的接口文档 就漂亮多了 顺藤摸瓜 得到如下工具
https://github.com/readmeio/apidoc
http://apidocjs.com/example/
2、
http://apievangelist.com/2014/03/08/hello-world-product-api-with-blueprint-raml-and-swagger/
Hello World Product API With Blueprint, RAML And Swagger
一份评估报告Which API editor to use?
https://medium.com/@orliesaurus/a-review-of-all-most-common-api-editors-6a720dc4f4e6
PPT:slideshare
Publishing strategies for API documentation
http://www.slideshare.net/TomJohnson7/publishing-strategies-for-api-documentation
API Technical Writing
Proof of life: Your API documentation is your API
Making API documentation work
Ask HN: What's the best way to write an API spec?
https://news.ycombinator.com/item?id=8912897
收获：这里面打广告的蛮多的，几乎提到了当下比较主流的一些定义和编辑方式、工具。
为什么放弃swagger
Why We Dropped Swagger And I/O Docs
http://devo.ps/blog/why-we-dropped-iodocs-and-swagger/
文档编写方案
https://github.com/devo-ps/carte
五颗星 另一篇评估报告RAML vs Swagger vs Apiary vs RSpec
https://lonelyplanet.atlassian.net/wiki/display/PUB/API+Specification%2C+Automated+Testing%2C+and+Documentation+Generation+Discussion