Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-49607

Using Swagger to generate API Documentation

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: Future Dev
    • Fix Version/s: None
    • Component/s: Web Services

      Description

      We can use Swagger to generate API Documentation.

      From Swagger.io "Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment environment. With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability."

      Demo : http://petstore.swagger.io/

      PHP Library : https://github.com/zircote/swagger-php

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            rtz9 RitZ
            Participants:
            Component watchers:
            Juan Leyva, Amaia Anabitarte, Carlos Escobedo, Ferran Recio, Ilya Tregubov, Sara Arjona (@sarjona)
            Votes:
            9 Vote for this issue
            Watchers:
            13 Start watching this issue

              Dates

              Created:
              Updated: