2016-08-02 11 views
2

Ich schreibe eine Prahlerei spec und ich habe drei verschiedene Endpunkte. Wie separiere ich sie in meiner Dokumentation? Ich möchte eine klare Unterscheidung zwischen Beispiel haben: Benutzer, Beiträge & Andere. So würde jeder eine CRUD-Beschreibung haben und in swagger UI angezeigt werden würde es aussehen:Erstellen von Abschnitten in Prahlerei

Antwort

5

Sie müssen Tags verwenden, um dies zu erreichen.

Also, auf dem „Wege“ Objekt, sortieren Sie alle Ihre Routen und auf jeden, Sie fügen Sie ein „tags“: [ „{} Ressource“], wo sie gruppiert werden sollen.

Zum Beispiel:

"paths": { 
    "/users": { 
     "get": { 
      "tags": ["User"], 
      "description": "...", 
     }, 
     "post": { 
      "tags": ["User"], 
      "description": "...", 
     } 
    }, 

    "/posts": { 
     "get": { 
      "tags": ["Post"], 
      "description": "...", 
     }, 
     "post": { 
      "tags": ["Post"], 
      "description": "...", 
     } 
    }, 

    "/other": { 
     "get": { 
      "tags": ["Other"], 
      "description": "...", 
     }, 
     "post": { 
      "tags": ["Other"], 
      "description": "...", 
     } 
    }, 
} 

Dies ist nicht offensichtlich überhaupt auf der Dokumentation. Tatsächlich ist die Dokumentation sehr vollständig, aber es fehlt ein Index und eine Organisation.

+1

Dank MWM! Prost. – cnak2

+0

Wir haben ein Inhaltsverzeichnis in V3 :-) https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md –

Verwandte Themen