swagger-api/swagger-codegen

Add endpoint examples defined in the spec to API servers

Aperta

#5423 aperta il 19 apr 2017

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Enhancement: FeatureFeature List: API serversServer: C-SharpServer: ErlangServer: GoServer: HaskellServer: JavaServer: NodejsServer: PHPServer: PythonServer: RubyServer: ScalaServer: Springhelp wanted

Metriche repository

Star
 (12.701 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Description

Similar to what we've done for SpringMVC generator, we want to add support of endpoint examples defined in the spec to the auto-generated server stubs.

Ref: https://github.com/swagger-api/swagger-codegen/pull/5411

Endpoint example support in the server generators:

  • C# (NancyFx, ASP.net Core)
  • Elixir
  • Erlang
  • Go
  • Haskell Servant
  • JavaScript/NodeJS
  • Java (MSF4J, Spring:white_check_mark:, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy)
  • PHP (Lumen, Slim, Silex, Zend Expressive)
  • Python Flask
  • Ruby (Sinatra, Rails)
  • Scala Finch
  • Scala Scalatra
Suggest a Fix

#5411 is a good reference. If anyone wants to contribute to this task, please reply to let us know. Thank you.

Guida contributor

Direzione di ricerca
Esamina il PR di riferimento #5411 per capire come sono stati aggiunti esempi di endpoint per il generatore di server SpringMVC. Indaga i file template corrispondenti (ad es. template mustache) e le classi di codegen per gli altri generatori di server elencati. Per ogni linguaggio target, identifica dove i dati di esempio degli endpoint sono disponibili nel modello OpenAPI e modifica il template per produrre gli esempi. Considera di contribuire in modo incrementale, un linguaggio alla volta.
Tech stack
java
Dominio
backendapi
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65