Download to read offline
Uploaded bysmirolo
Documenting an API written in Django Rest Framework
The document discusses the process of documenting APIs using Django Rest Framework, detailing a series of attempts with various tools such as drf-yasg and Swagger. It highlights specific challenges encountered in the documentation process, including issues with API inputs, outputs, and formatting. The author, Sebastien Mirolo, provides insights into solutions and practices for creating effective API documentation.
More Related Content
Similar to Documenting an API written in Django Rest Framework
![Lect 1 Number systems and base conversions. [Autosaved].pptx](https://cdn.slidesharecdn.com/ss_thumbnails/lect1numbersystemsandbaseconversions-260111134109-67c2d865-thumbnail.jpg?width=640&height=640&fit=bounds)
Documenting an API written in Django Rest Framework
- 1. Documenting Django Rest Framework APIs SebastienMirolo @seabasscapoeira smirolo@djaodjin.com
- 2. A bit ofbackground (API on read-the-docs)
- 3. New API doc (Endresult)
- 4. Where to start? OpenAPI(formerly known as Swagger) API Blueprint
- 5.
- 6.
- 7.
- 8.
- 9.
- 10. drf-yasg Problems to solve •Tags • API returning list of elements • Issues with URL override • Missing query parameters • API inputs and outputs • Additional pagination parameters • Write-only parameters • Converting docstrings • reStructuredText • Extracting examples • Remove WIP APIs from documentation
- 11. Django Translation • Formatstrings • Marking gettext strings as safe • Cleaning up messages
- 12. Thank You Sebastien Mirolo @seabasscapoeira smirolo@djaodjin.com Readmore at https://djaodjin.com/blog/django-rest-framework-api- docs.blog.html