W mojej dokumentacji API, chciałbym zdefiniować zabezpieczenia niezbędne dla każdego punktu końcowego API. Projekt zdefiniował role i uprawnienia określające, którzy użytkownicy mogą uzyskać dostęp do interfejsów API. Jaki jest najlepszy sposób, aby w Swagger udokumentować te informacje? Czy istnieje najlepsza praktyka lub zalecenie, jak wyświetlić te szczegóły?Jak zdefiniować zabezpieczenia roli/uprawnień w Swagger
To, co wypróbowałem używając securityDefinitions i zdefiniowanej przez siebie zmiennej dla ról, ale ta informacja (x-role-names) nie została skopiowana do dokumentacji, kiedy przeprowadziłem ją przez swagger2markup lub używając swagger- ui.
"securityDefinitions": {
"baseUserSecurity": {
"type": "basic",
"x-role-names": "test"
}
}
Jaki jest najlepszy sposób udokumentowania roli i informacji o uprawnieniach na punkt końcowy?
Widzę opis w specyfikacji, ale nie widzę streszczenia. Która wersja jest dostępna w? Tak czy siak, niestety, te wydają się być wyświetlane tylko w ogólnym bloku bezpieczeństwa, a nie przy każdym wywołaniu API, które byłoby bardziej idealne. Wygląda na to, że określenie swagger2markup z zakresu podstawowego jest dozwolone, ale jest niezgodne ze specyfikacją, więc mogę "zhakować" to, aby było bardziej podobne do nadziei - ale nadal nie jest idealne. – whatsTheDiff
Przepraszam, myślałem o "streszczeniu", a nie "streszczeniu", ale byłby to na poziomie operacyjnym, a nie definicji SecurityDefinition. – MikeRalphson