Realizacja · 2025

docs.vpodarok.ru -usługa dokumentacji API

Konstruktor dokumentacji: struktura i katalogi, Import i eksport Swagger, ręczna edycja metod, współpraca, dostęp prywatny i publiczny.

Laravel Alpine.js TypeScript MariaDB GitLab CI
Strona główna docs.vpodarok.ru: konstruktor dokumentacji dla API

Zadanie

Grupa usług klienta zgromadziła wiele interfejsów API dla klientów i partnerów, a dokumentacja żyła w różnych plikach Swagger i korespondencji. Potrzebne było jedno narzędzie, w którym zespół prowadzi dokumentację, a klienci czytają ją bez konieczności kontaktowania się z Pomocą techniczną.

Decyzja

W ciągu miesiąca zebraliśmy usługę dokumentacji: strukturę katalogów i plików, import istniejących opisów Swagger i eksport z powrotem, ręczną edycję metod, Ustawienia globalne i statystyki dokumentacji. Dokumentacja może być prywatna lub otwarta dla klientów, a praca nad nią może być przekazywana osobom trzecim z ograniczonymi prawami.

Technologia-Laravel, Alpine.js i TypeScript, MariaDB, GitLab CI. Lekki frontend bez ciężkiego SPA: strony dokumentacji są szybkie i indeksowane.

Wynik

Jeden punkt prawdy na wszystkich API klienta. Nowe metody są opisywane w interfejsie w ciągu kilku minut, partnerzy otrzymują aktualną dokumentację i piaskownicę, a wsparcie zawiera mniej pytań "Jak wywołać metodę".

Porozmawiajmy o projekcie

Podobne zadanie? Porozmawiajmy, jak je rozwiązać

Kontakt