Skip to content

Markdown API Docs

冒菜略寡味 edited this page May 16, 2018 · 2 revisions

DRF接口文档内容扩展

django-rest-swagger虽然很好的为我们完成了接口文档化,但是文档内容还是比较单薄,

对于一些较为复杂的接口,我们希望能在文档中给出更多的信息内容,这样方便前端同学能够详细了解接口,同时也能节省沟通成本;

这篇 documenting-your-api大致讲了如何去完善补充接口文档内容,

同时需要提及到得是,在视图函数中我们可以在文档字符串当中,通过markdown的方式编写接口文档,并展示于swagger文档中;

代码可查阅如下:

在该接口中,使用Markdown定义了些表格和代码片段,丰富了接口文档信息,感觉还是挺不错的;

昨日擔當 昨日敢想

昨日轉眼 就跌撞

夏時夢長 秋時晝短

清冽途上 不遠望

Clone this wiki locally