Pracuję nad restAPAP przy użyciu Express.js i zastanawiam się, czy istnieje sposób dla mnie do generowania dokumentów API, które pozwalają użytkownikowi przeglądać definicje API lub może nawet wypróbować wywołanie API?Generator dokumentów REST API Node.js lub Express.js
Swagger to niesamowity projekt do automatycznego generowania dokumentacji API. Zawiera moduł Express.
Co szukasz jest dobrym JavaScript generator dokumentacji. Znalazłem przyzwoity tutaj http://apidocjs.com/example/. Umożliwi to korzystanie z funkcji Express, takiej jak op.
Swagger nie jest przeznaczony do dokumentów, ale do tworzenia interfejsów API. Aby uzyskać tę funkcję, musisz nauczyć się pełnego systemu.
znalazłem kilka bardziej tutaj, że nie w pełni jeszcze spojrzał na które wydają się obiecujące:
Docco here JSDoc here i an article on Documentor for Node
Dzięki @dankohn. Sprawdzam to. –
Czy generują się automatycznie na podstawie tras skonfigurowanych w trybie ekspresowym? – lostintranslation
@lostintranslation AFAIK one nie. Dokumentacja Swagger jest zapisywana w plikach yml. – BillyTom