简体繁体 English

REST API项目的文档

[英]documentation for REST API project

原文 2014-06-12 09:29:42 4 1 python/ django/ rest

i want to make documentation of my DJANGO REST framework project like twitter documentation [ https://dev.twitter.com/docs/api/1.1] 我想制作我的DJANGO REST框架项目的文档，例如twitter文档[ https://dev.twitter.com/docs/api/1.1]

how can i do it? 我该怎么做？

is there any better way to implement documentation rather then this one? 有没有比这更好的方法来实现文档了？

1 个解决方案

DRF provides its own description for what you are asking in documenting your api section. 对于您在记录api部分时要问的内容，DRF提供了自己的描述。 Choose the one that suits you better. 选择一个更适合您的。

是否可以针对Django中的文档测试REST API？ - Is it possible to test a REST API against documentation in Django?

将实时 Django 项目转换为 REST API 项目 - Convert live Django project to REST API project

在同一项目中使用Django Rest Api - Consuming Django Rest Api in the same project

我正在为我的 Django rest api 文档使用 drf-spectacular，如何覆盖我们自己的端点 - Am using drf-spectacular for my Django rest api documentation, how to override our own endpoint

为什么这个django-rest-swagger API文档不能正常显示/工作？ - Why won't this django-rest-swagger API documentation display/work properly?

带有Sphinx的Django项目文档 - Django project documentation with sphinx

如何从 Django 内置 API 文档中排除 rest-auth 端点？ - How can I exclude rest-auth endpoint from the Django built-in API documentation?

Django rest API，可以自动执行文档吗？ - Django rest APIs, automate documentation?

django rest 框架离线文档 - django rest framework offline documentation

为什么新创建的项目不显示内置API Django文档？ - Why newly created project doesn't display built-in API Django documentation?

暂无

暂无

声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

相关问题 是否可以针对Django中的文档测试REST API？ - Is it possible to test a REST API against documentation in Django? 将实时 Django 项目转换为 REST API 项目 - Convert live Django project to REST API project 在同一项目中使用Django Rest Api - Consuming Django Rest Api in the same project 我正在为我的 Django rest api 文档使用 drf-spectacular，如何覆盖我们自己的端点 - Am using drf-spectacular for my Django rest api documentation, how to override our own endpoint 为什么这个django-rest-swagger API文档不能正常显示/工作？ - Why won't this django-rest-swagger API documentation display/work properly? 带有Sphinx的Django项目文档 - Django project documentation with sphinx 如何从 Django 内置 API 文档中排除 rest-auth 端点？ - How can I exclude rest-auth endpoint from the Django built-in API documentation? Django rest API，可以自动执行文档吗？ - Django rest APIs, automate documentation? django rest 框架离线文档 - django rest framework offline documentation 为什么新创建的项目不显示内置API Django文档？ - Why newly created project doesn't display built-in API Django documentation?

相关标签

粤ICP备18138465号 © 2020-2024 STACKOOM.COM