grpc-ecosystem/grpc-gateway

Document protoc-gen-swagger

Open

#427 aperta il 4 lug 2017

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)Go (2250 fork)batch import
documentationhelp wantedopenapi

Metriche repository

Star
 (16.971 star)
Metriche merge PR
 (Merge medio 8g 23h) (147 PR mergiate in 30 g)

Descrizione

There's no obvious documentation on how to actually comment .proto files so they can be parsed by protoc-gen-swagger. It'd be useful if some was added.

Guida contributor

Direzione di ricerca
Rivedi la documentazione esistente nel repository, in particolare il README e qualsiasi esempio. Esamina il codice sorgente del plugin protoc gen swagger per capire come analizza i commenti. Fornisci esempi di annotazioni Swagger comuni nei file .proto e spiegane gli effetti.
Tech stack
go
Dominio
backendapi
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ProtobufGo
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90