Я создал приложение Angular перед созданием бэкэнда. Есть ли сервис/пакет npm/библиотека/и т. д., который я могу использовать, который сканирует все службы приложений и их http-запросы и генерирует swagger, чтобы бэкэнд-разработчик использовал это?
Я знаю, что есть некоторые инструменты, чтобы сделать это наоборот (создать Angular Services из чванства), но у меня уже есть код, я хочу создать документацию для конечных точек, которые я использую/ожидаю
compodoc
должен иметь возможность генерировать json, следуя аннотациям JSDoc, добавленным в методы службы Angular. https://compodoc.github.io/compodoc-demo-todomvc-angular/index.html который потом можно скормить чванству.
npm install -g @compodoc/compodoc
Затем настройте компдок
{
"title": "My Angular App API Documentation",
"sourceDir": "src/app",
"exportFormats": ["swagger"]
}
Услуги аннотирования
import { HttpClient } from '@angular/common/http';
import { Injectable } from '@angular/core';
/**
* A service for interacting with the My API.
*/
@Injectable({
providedIn: 'root'
})
export class MyApiService {
/**
* Retrieves the list of users.
* @returns An observable that emits the list of users.
*/
getUsers() {
return this.http.get<User[]>('/api/users');
}
constructor(private http: HttpClient) { }
}
Чтобы сгенерировать swagger.json
compodoc -p tsconfig.app.json
Выходной файл можно потом отдать ребятам из BE?
вроде нет таких инструментов