sunliwen / poco

Poco v1.6
0 stars 1 forks source link

用django-rest-swagger维护API文档 #88

Closed jacobfan closed 5 years ago

jacobfan commented 10 years ago

liwen提出用django-rest-swagger维护API文档

  1. 需要调研一下django-rest-swagger的api文档跟我们目前的格式相比可能会有哪些限制;
  2. 需要调研一下如何和其他文档(例如tutorial)部分结合起来。

liwen: we have to make the api documentation easier

liwen [22:30] https://github.com/marcgibbons/django-rest-swagger/

GitHub marcgibbons/django-rest-swagger django-rest-swagger - Swagger Documentation Generator for Django REST Framework

listili: @liwen 这个得把全部文档都挪到代码里面

jacobfan [11:52] 这个只是api 文档,同时还需要写一些tutorial等文档吧。

jacobfan [11:52]11:52 还有一点就是这个api文档格式上有哪些限制?

liwen [11:56] 可以issue一下 咱们讨论一下

liwen [11:56] 感觉比纯手写维护 要容易一些

liwen [11:56] 当然tutorial还是不能被替代的

liwen [11:56] 也许是加 不是替代

jacobfan commented 10 years ago

@sunliwen @lisztli