Wprowadzenie

  • 2 min

Istnieje wiele korzyści związanych z dokumentowaniem tworzonego oprogramowania. Solidna dokumentacja nie tylko ułatwia utrzymanie kodu, ale także pomaga innym osobom z niego korzystać. Usprawnianie korzystania z kodu jest szczególnie ważne, jeśli Twojego interfejsu API chce używać wiele innych osób. Na szczęście dostępne są narzędzia i struktury, które obniżają koszt tworzenia dobrej dokumentacji.

Załóżmy, że jesteś głównym deweloperem w firmie zajmującej się oprawianiem drukowanych zdjęć w ramki. Firma decyduje się na publiczne udostępnienie swoich interfejsów API. Wiele interfejsów API nie ma istniejącej dokumentacji i odpowiada za ich udokumentowanie. Dokumentowanie interfejsów API ułatwia partnerom prawidłowe korzystanie z nich, co powoduje obniżenie kosztów pomocy technicznej i konserwacji.

Potrzebujesz łatwego i ustandaryzowanego sposobu dokumentowania każdego interfejsu API. Potrzebna jest również metoda hostowania dokumentacji w lokalizacji dostępnej dla partnerów.

W tym module dowiesz się, jak udokumentować istniejący interfejs API platformy ASP.NET Core przy użyciu programu Swashbuckle, Swagger, Swagger UI i interfejsu OpenAPI.

Cele szkolenia

Zawartość tego modułu:

  • Dowiedz się więcej o programie Swashbuckle, interfejsie OpenAPI i interfejsie użytkownika struktury Swagger.
  • Włącz interfejs OpenAPI dla interfejsu API języka C#/ASP.NET Core.
  • Użyj pakietu Swashbuckle w interfejsie API języka C#/ASP.NET Core.
  • Generowanie i wyświetlanie dokumentacji interfejsu API za pomocą interfejsu OpenAPI.

Wymagania wstępne

  • Doświadczenie w projektowaniu i implementacji interfejsów API REST.
  • Doświadczenie w opracowywaniu podstawowych aplikacji platformy ASP.NET Core.
  • Lokalne instalacje zestawu .NET SDK, programu Visual Studio Code i rozszerzenia języka C# dla programu Visual Studio Code.