swagger-api/swagger-codegen

Add endpoint examples defined in the spec to API servers

Open

#5.423 geöffnet am 19. Apr. 2017

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Enhancement: FeatureFeature List: API serversServer: C-SharpServer: ErlangServer: GoServer: HaskellServer: JavaServer: NodejsServer: PHPServer: PythonServer: RubyServer: ScalaServer: Springhelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche den Referenz PR #5411, um zu verstehen, wie Endpunkt Beispiele für den SpringMVC Server Generator hinzugefügt wurden. Untersuche die entsprechenden Vorlagendateien (z.B. Mustache Vorlagen) und Codegen Klassen für die anderen aufgeführten Server Generatoren. Identifiziere für jede Zielsprache, wo die Endpunkt Beispieldaten im OpenAPI Modell verfügbar sind, und passe die Vorlage an, um Beispiele auszugeben. Erwäge, inkrementell beizutragen, jeweils eine Sprache auf einmal.
Tech Stack
java
Domain
backendapi
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65