Uploaded image for project: 'MusicBrainz Server'
  1. MusicBrainz Server
  2. MBS-12169

Autogenerated/interactive API documentation

    • City

      From recurring discussions during the past years, it would be very helpful for MusicBrainz API users to have an auto-generated online documentation:

      • It would be complete if auto-generated (from MMD Schema);
      • It would be easier to keep it synchronized with the actual API;
      • It would have better coverage than current examples if interactive.

      From the research efforts published in comments to MBS-5307, it seems that Swagger UI would be an appropriate tool to deploy for this purpose. This has already been successfully tested for BookBrainz API documentation.

            reosarevok Nicolás Tamargo
            yvanzo yvanzo
            Votes:
            0 Vote for this issue
            Watchers:
            8 Start watching this issue

              Created:
              Updated:

                Version Package