Могу ли я создать swagger или другую документацию API из Angular Services?

Я создал приложение Angular перед созданием бэкэнда. Есть ли сервис/пакет npm/библиотека/и т. д., который я могу использовать, который сканирует все службы приложений и их http-запросы и генерирует swagger, чтобы бэкэнд-разработчик использовал это?

Я знаю, что есть некоторые инструменты, чтобы сделать это наоборот (создать Angular Services из чванства), но у меня уже есть код, я хочу создать документацию для конечных точек, которые я использую/ожидаю

вроде нет таких инструментов

Andrei 30.03.2023 22:17
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Angular и React для вашего проекта веб-разработки?
Angular и React для вашего проекта веб-разработки?
Когда дело доходит до веб-разработки, выбор правильного front-end фреймворка имеет решающее значение. Angular и React - два самых популярных...
Эпизод 23/17: Twitter Space о будущем Angular, Tiny Conf
Эпизод 23/17: Twitter Space о будущем Angular, Tiny Conf
Мы провели Twitter Space, обсудив несколько проблем, связанных с последними дополнениями в Angular. Также прошла Angular Tiny Conf с 25 докладами.
Угловой продивер
Угловой продивер
Оригинал этой статьи на турецком языке. ChatGPT используется только для перевода на английский язык.
Мое недавнее углубление в Angular
Мое недавнее углубление в Angular
Недавно я провел некоторое время, изучая фреймворк Angular, и я хотел поделиться своим опытом со всеми вами. Как человек, который любит глубоко...
Освоение Observables и Subjects в Rxjs:
Освоение Observables и Subjects в Rxjs:
Давайте начнем с основ и постепенно перейдем к более продвинутым концепциям в RxJS в Angular
0
1
56
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

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?

Другие вопросы по теме