Swagger for Django api

This page summarizes the projects mentioned and recommended in the original post on /r/django

Stream - Scalable APIs for Chat, Feeds, Moderation, & Video.
Stream helps developers build engaging apps that scale to millions with performant and flexible Chat, Feeds, Moderation, and Video APIs and SDKs powered by a global edge network and enterprise-grade infrastructure.
getstream.io
featured
InfluxDB – Built for High-Performance Time Series Workloads
InfluxDB 3 OSS is now GA. Transform, enrich, and act on time series data directly in the database. Automate critical tasks and eliminate the need to move data externally. Download now.
www.influxdata.com
featured
  1. drf-yasg

    Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.

    I believe drf-yasg what you need. You can create a schema manually and define request and response types for your small API.

  2. Stream

    Stream - Scalable APIs for Chat, Feeds, Moderation, & Video. Stream helps developers build engaging apps that scale to millions with performant and flexible Chat, Feeds, Moderation, and Video APIs and SDKs powered by a global edge network and enterprise-grade infrastructure.

    Stream logo
  3. I did this in one of my projects: https://gitlab.com/mrswats/config-server/-/commit/b5dac490bc3e12a6d4f2090b11b3616b82aaf300

  4. drf-spectacular

    Sane and flexible OpenAPI 3 schema generation for Django REST framework.

    I would suggest drf-spectacular instead because https://github.com/axnsan12/drf-yasg#openapi-30-note

  5. swagger-ui

    Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

    Then you need a html file that loads swagger-ui and points towards your openapi.json file from the previous step. Look at the unpkg example here for the easiest way to set one up. Either hard code the url in the file or serve it as a django template that fills in the correct value.

  6. swagger-editor

    Swagger Editor

    Sure. You can use the editor from here for instance to define your endpoints and the data received and returned. By looking at the preloaded example you can figure out most of what you need to know about openapi. But if you need more info, the official documentation is pretty good.

  7. InfluxDB

    InfluxDB – Built for High-Performance Time Series Workloads. InfluxDB 3 OSS is now GA. Transform, enrich, and act on time series data directly in the database. Automate critical tasks and eliminate the need to move data externally. Download now.

    InfluxDB logo
NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts

  • How to deal with toxicity within the community, in context of big open source projects?

    3 projects | /r/SoftwareEngineering | 10 Mar 2023
  • Swagger Made Simple: A Walkthrough of API Documentation

    3 projects | dev.to | 20 Oct 2024
  • Simplifying Angular Development with Swagger: A Step-by-Step Guide

    3 projects | dev.to | 11 Apr 2024
  • Azure API Management DevOps

    4 projects | dev.to | 7 Oct 2022
  • Document your API with OpenAPI standard

    4 projects | dev.to | 29 May 2022

Did you know that Python is
the 2nd most popular programming language
based on number of references?