search

wanghaisheng / fhir-cn

FHIR中文版 the Chinese translation of FHIR
https://github.com/FHIR-CN/fhir-spec-ZhCN
73 stars 23 forks source link

FHIR 接口文档美化的评估 #23

Open wanghaisheng opened 9 years ago

wanghaisheng commented 9 years ago

发了一封邮件 征询是否采用swagger 或RAML的接口描述方式以及其接口文档生成的方式来对FHIR现有的REST接口文档进行美化 未果，仍得自己进行评估

wanghaisheng commented 9 years ago

效果列表： 1、周末看到Akido创业公司在做医院内部的API 查看他们的接口文档 就漂亮多了 顺藤摸瓜 得到如下工具 https://github.com/readmeio/apidoc http://apidocjs.com/example/ 2、

wanghaisheng commented 9 years ago

工具和技术列表 https://github.com/mashery/iodocs

wanghaisheng commented 9 years ago

https://developer.paypal.com/docs/api/

wanghaisheng commented 9 years ago

http://apievangelist.com/2014/03/08/hello-world-product-api-with-blueprint-raml-and-swagger/ Hello World Product API With Blueprint, RAML And Swagger

wanghaisheng commented 9 years ago

https://github.com/mashery/iodocs

wanghaisheng commented 9 years ago

https://speca.io/

wanghaisheng commented 9 years ago

https://github.com/apidoc/apidoc-spec

wanghaisheng commented 9 years ago

https://github.com/Mashape/apiembed

wanghaisheng commented 9 years ago

一份评估报告Which API editor to use? https://medium.com/@orliesaurus/a-review-of-all-most-common-api-editors-6a720dc4f4e6

wanghaisheng commented 9 years ago

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

wanghaisheng commented 9 years ago

Ask HN: What's the best way to write an API spec? https://news.ycombinator.com/item?id=8912897

收获：这里面打广告的蛮多的，几乎提到了当下比较主流的一些定义和编辑方式、工具。

wanghaisheng commented 9 years ago

为什么放弃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

wanghaisheng commented 9 years ago

五颗星 另一篇评估报告RAML vs Swagger vs Apiary vs RSpec https://lonelyplanet.atlassian.net/wiki/display/PUB/API+Specification%2C+Automated+Testing%2C+and+Documentation+Generation+Discussion

wanghaisheng commented 9 years ago

http://apievangelist.com/2014/03/08/hello-world-product-api-with-blueprint-raml-and-swagger/

wanghaisheng commented 9 years ago

http://www.slidesearchengine.com/slide/another-api-blueprint-raml-and-swagger-comparison

wanghaisheng commented 9 years ago

新东西 https://github.com/apiaryio/mson

wanghaisheng commented 9 years ago

http://apidocjs.com/

wanghaisheng commented 9 years ago

http://pragmatiqa.com/xodata/

wanghaisheng commented 9 years ago

https://github.com/tripit/slate

wanghaisheng commented 9 years ago

结论
https://github.com/wanghaisheng/awesome-http-api/issues/3