W poprzednim wpisie wyjaśniłem, 'dlaczego' i 'jak' powinniśmy go generować. Teraz nadszedł czas, aby dowiedzieć się 'jak go używać' w rzeczywistym projekcie.
HomeNotificationsListsStories WriteTaşkın BinbirFollow ·2 min read Hello everybody, I am going to tell frequently used extended swagger features in this article. The main contents of this article are as follows; summary, remarks, responses. How and why to use ProducesResponseType attribute ? Firstly, I start with response. We have many http status code. The first things that come to mind are 200, 201, 400, 404. We use the ProducesResponseType attribute for these cases. e.g.;[ProducesResponseType(...
Podstawowa konfiguracja Swagger jest bardzo skromna. Zróbmy zatem coś więcej i dołączmy dokumentacje XML do Swagger UI.
Sztuka programowania 1625 dni, 18 godzin, 15 minut temu 58 źrodło rozwiń
Leniwy programista to wydajny programista. Przekonajmy się 🙂 Mamy do sprawdzenia API, które ma dokumentacje w Swagger. Możemy z poziomu UI wywołać i sprawdzić odpowiedzi dla żądań. Jednak w celu automatyzacji najlepiej napisać żądania i testy w Postman. Unikniemy dzięki temu manualnej roboty w Swagger UI. Super automatyzacja, ale chwila czy w Postman wszystkie parametry i żądania musimy ręcznie zadeklarować?
Na blogu pojawiło się kilka różnych artykułów dotyczących tego, jak wykorzystać Postmana do testowania WebApi. W tym artykule pokażę, w jaki sposób przyśpieszyć dodawanie żądań do Postmana, szczególnie w sytuacji, gdy zaczynamy używać Postmana z już istniejącym WebApi. Wykorzystamy do tego opisywaną już na blogu bibliotekę Swagger, która dokumentuje nasze API. Postman jest w stanie zaimportować taki opis i na podstawie tego wygenerować żądania do nowej kolekcji...
Od wielu lat usługi REST wypierają stare dobre usługi SOAP (a można już chyba nawet powiedzieć, że wyparły). Kiedy zaczynałem tworzyć usługi REST oraz z nich korzystać, miałem w pewnym sensie wrażenia, że robimy krok w tył. W SOAP mieliśmy WSDLa, który opisywał usługę. Dzięki niemu Visual Studio mogło wygenerować wszystkie klasy, które następnie używałem do komunikacji z usługą. W przypadku usług RESTowych nie mamy czegoś takiego z pudełka. Więc bardzo często ...
A więc wracamy do serii o Azure Functions po przerwie chorobowej i dochodzeniu do siebie. W kolejnym tygodniu z Azure Functions chciałbym pokazać jak można zaprezentować nasze API używając Swagger. Mała uwaga na chwilę obecną wsparcie dla OpenAPI Specification jest tylko dostępne dla funkcji działających na silniku v1. Wersja beta nie jest jeszcze niestety wspierana. O Azure Functions pisałem już w p...
Masz jakieś API chciałbyś sprawdzić listę swoich endpointów? Swagger to najlepsze narzędzie do tego – do tworzenia interaktywnej dokumentacji API.
Chciałbym podzielić się dziś z wami wiedzą o Swagger’ze, świetnym narzędziu do prostego, bezbolesnego, a co najważniejsze szybkiego i skutecznego dokumentowania API.
Prezentacja frameworka, który wspomoże nas w tworzeniu przejrzystej i funkcjonalnej dokumentacji dla API.
Dzisiaj chciałbym pokazać Swagger, doskonałe narzędzie służące do dokumentacji REST API. Swagger, korzysta z plików JSON, którymi można opisać nasze API. W przypadku RESTful api m.in. możemy określić:Nazwę zasobuTyp zwracanych danychOpis obiektówWersję APIZwracane kody statusu HTTPParametry (np. query lub HTTP body)HTTP verbs (PUT, GET, POST etc)
Zewnętrzni dostawcy tożsamości korzystają z technologii OpenID, dzięki której Twoje hasło zawsze jest poufne i nie musisz zapamiętywać kolejnego.
Wprowadź nazwę użytkownika/e-mail oraz hasło
Zaloguj się przy użyciu Facebooka.
Podaj nazwę użytkownika i adres e-mail, aby założyć konto. Dzięki niemu będziesz na bieżąco informowany o zmianach w serwisie.
