Narzędzie do generowania i hostowania dokumentacji

0

Poszukuję czegoś w stylu Swagger ale do tworzenia dokumentacji dla elementów kodu innych niż endpointy API. Mamy system oparty o architekturę event-driven i musimy wystawić dokumentację opisującą każdy event jak i jego atrybuty. Najlepiej gdyby takie narzędzie tworzyło przykładową JSON schema takiego eventu i dostarczało UI do wyświetlania dokumentacji- podobnie jak Swagger. Niby można by coś takiego postawić samemu ale chcemy to zrobić jak najmniejszym nakładem pracy.

Czy ktoś spotkał się z podobnym narzędziem lub takiego używa?

1

DocX ?

2

Nie wygląda to na coś choćby odrobinę dostarczającego tego czego ja potrzebuję

Czyli to jest skomplikowany problem i pierwszy link skopiowany z google nie działa :P . To może trzeci link czyli Doxygen ?

3
Aventus napisał(a):

Czy ktoś spotkał się z podobnym narzędziem lub takiego używa?

W dokumentacji .NET masz wymienione 2 narzędzia:

0

@KamilAdam: zapewniam że również korzystałem z Google ;) Nic oczywistego na pierwszy rzut oka się nie pojawia. Chodzi przede wszystkim o to aby selektywnie można było generować dokumentację tylko dla konkretnych klas, oraz- co również ważne- automatycznie hostować tę dokumentację. Jak już wspomniałem, podobnie do tego co robi Swagger. Zresztą jak nic lepszego nie znajdziemy to użyjemy właśnie Swagger, ale on lepiej się nadaje do dokumentowania API a nie konkretnych klas. Doxygen nie wydaje się spełniać tego. Znalazłem jeszcze coś takiego jak AsyncAPI . Ciekaw po prostu jestem czy ktoś tutaj na forum miał styczność z podobnymi narzędziami i może coś polecić.

0

Zazwyczaj się dokumentuje kod inline tak jak tutaj https://docs.microsoft.com/en-us/dotnet/csharp/codedoc
i najczęściej używa się DocFX do wygenerowania dokumentacji. Co Ci nie pasuje w tym rozwiązaniu?

0

Nigdzie nie napisałem że mi coś nie pasuje. Sprawdzę DocFX chociaż problemem może być to że z tego co widzę domyślnie generuje dokumentację na podstawie wszystkich komentarzy. Jak już wspomniałem zależy mi na selektywnym generowaniu.

0

Może narzedzie do continuous delivery/ deployment? https://www.gocd.org/

1 użytkowników online, w tym zalogowanych: 0, gości: 1