typescript - Dokumentere Graphql-skjema ved bruk av Nestjs Code-first-tilnærming

Finnes det en måte å legge til kommentarer til mutasjoner og spørringer i skjemaet ditt generert gjennom kode-først-tilnærmingen i Nestjs?

Svar #1

Når man bruker dekoratorene som @Field, @ObjectType og noen andre

Du kan bruke beskrivelse: 'noen kommentar'

Og så vil du se kommentarene i GraphQL-lekeplassen

Eksempel

@ObjectType( {description : 'My class') )
Class Person {
    @Field ( () => ID, { description : ' ID of the user' } ) 
    Id: number
}