@tc-libs/doc

@tc-libs/doc

Helper Swagger/OpenAPI per uniformare la documentazione degli endpoint.

I decorator principali sono:

• Doc()
• DocPaging()
• DocDefault()
• DocOneOf()
• DocAnyOf()
• DocAllOf()

Cosa fa

Automatizza:

• ApiConsumes e ApiProduces
• response standard o paginata
• header x-custom-lang
• query di pagination
• documentazione errori standard del monorepo
• supporto auth JWT, refresh, API key e permission token

Esempio endpoint standard

@Get(':id')
@Doc('user.get', {
  auth: { jwtAccessToken: true },
  response: {
    serialization: UserGetSerialization,
  },
  request: {
    params: [{ name: 'id', required: true, type: String }],
  },
})

Esempio endpoint paginato

@Get()
@DocPaging('user.list', {
  auth: { jwtAccessToken: true },
  response: {
    serialization: UserListSerialization,
    availableSearch: ['email', 'name'],
    availableOrderBy: ['createdAt', 'email'],
  },
})

Tipi utili

• IDocOptions
• IDocPagingOptions
• IDocAuthOptions
• IDocRequestOptions
• IDocResponseOptions

Note operative

• Per upload multipart usa bodyType: FORM_DATA.
• Per response file usa bodyType: FILE.
• Il package si appoggia ai serializzatori di @tc-libs/response.

Sviluppo

nx build doc
nx test doc