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
2
A
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.
Verwandte Themen
- 1. Erstellen von mehreren Abschnitten mit benutzerdefinierten Zellen
- 2. Wie sollte man Prahlerei von Laravel dienen?
- 3. Wie Prahlerei verwenden, um RESTful API zu erstellen
- 4. Ausblenden von unnötigen Sachen von JSONOject in Prahlerei
- 5. Gruppierte UITableView mit mehreren Abschnitten erstellen Problem in iPhone SDK
- 6. Wie leeres Array in Prahlerei definieren
- 7. Default Tableview - Löschen von Abschnitten
- 8. verfassen json Körper mit Prahlerei
- 9. Demontage von Abschnitten in einem c-Programm
- 10. Verschlüsseln von Abschnitten von web.config. Sollte ich?
- 11. Wiederverwendung komplexe feder Fuchs Prahlerei Anmerkung
- 12. Go-Prahlerei Antwort-Payloads keine Typen modellieren
- 13. Angeben Beispiel Prahlerei fragt andere als curl
- 14. Wie ein Bericht mit den Abschnitten und Seitenumbrüchen SSRS erstellen
- 15. Python las Konfigurationsdatei unabhängig von Abschnitten
- 16. Zeichnen von Beschriftungen auf flachen Abschnitten von Konturlinien in ggplot2
- 17. UITableView: Löschen von Abschnitten mit Animation
- 18. Wie Prahlerei-ui öffnen Docker mit
- 19. Einfügen von Zellen und Abschnitten aus Tabellenansichten
- 20. Prahlerei-CODEGEN ungültig Objekttyp Überspringen: Array
- 21. Android Listview mit Abschnitten
- 22. R - Mittelwert von bestimmten Abschnitten eines Vektors
- 23. Hinzufügen von Elementen zur Tabellenansicht mit Abschnitten
- 24. Erstellen eines Titels und Nummerierung von Abschnitten auf pdf bei Verwendung von R Markdown mit Pandoc
- 25. Automatisches Verschlüsseln von Abschnitten von web.config nach der Bereitstellung/Veröffentlichung?
- 26. Native Anzeigen in UITableView mit mehreren Abschnitten
- 27. Website mit ganzseitigen Abschnitten in Drupal?
- 28. Verwenden von appSettings-Werten in anderen Web.config-Abschnitten
- 29. Platzieren von zwei Abschnitten nebeneinander in einem UICollectionView
- 30. Benutzersteuerungswerkzeugspitze funktioniert nicht in transparenten Abschnitten
Dank MWM! Prost. – cnak2
Wir haben ein Inhaltsverzeichnis in V3 :-) https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md –