2014-11-28 18 views

Odpowiedz

15

Swagger UI to narzędzie, które pobiera pliki specyfikacji Swagger, przedstawia je wizualnie i umożliwia wykonywanie operacji.

Sam Swagger to specyfikacja do dokumentowania i opisywania interfejsów API REST. Specyfikację można znaleźć tutaj - https://github.com/swagger-api/swagger-spec/. Repozytorium zawiera samą specyfikację, schemat json, próbki i tak dalej. Główny plik README repozytorium wskazuje również na dodatkowe narzędzia, w tym biblioteki i frameworki do tworzenia specyfikacji.

Jeśli chodzi o tworzenie specyfikacji Swagger, można użyć jednej z ram i zintegrować ją z istniejącym kodem, aby automatycznie wygenerować taką dokumentację.

Jeśli nie masz istniejącej aplikacji lub chcesz ją udokumentować ręcznie, możesz użyć narzędzia Swagger-Editor lub wybranego edytora tekstu.

+0

Dzięki webronowi możesz uzyskać jasny obraz o swaggerze –

+0

Mam już działający interfejs API Swagger. Co jest potrzebne, aby interfejs użytkownika Swagger mógł wyświetlać dokumentację interfejsu API? Samo otwarcie './Dist/index.html' i przejście do mojego interfejsu API nie jest w stanie tego zrobić. Czy muszę obsługiwać 'swagger.json' ręcznie przez http? Czy mój interfejs API potrzebuje dodatkowego punktu końcowego, w którym po prostu obsługuje plik .json? Dzięki za wytłumaczenie. – atripes

+3

Pytanie jest niejasne i brakuje w nim szczegółów. Sugeruję albo rozpoczęcie nowego pytania z pełnymi szczegółami tutaj, albo skorzystanie z naszej grupy google, która jest ściślej monitorowana. – Ron

Powiązane problemy