我可以从Angular服务中创建一个swagger或其他API文档吗?

Question

我在创建后端之前创建了一个Angular应用。是否有一个服务/npm包/库/等我可以使用扫描整个应用程序的服务和它的http请求，并生成一个swagger，以便后端开发使用?

我知道有一些工具可以反过来做(从swagger中生成Angular服务)，但我已经有了代码，我想为我正在使用的端点创建文档/期望

Answer 1

compodoc应该能够按照添加到Angular服务方法中的JSDoc注释来生成json。https://compodoc.github.io/compodoc-demo-todomvc-angular/index.html然后可以喂给swagger。

npm install -g @compodoc/compodoc

配置compdoc

{
"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

输出文件可以给他们吗?