swagger-api / swagger-api/swagger-codegen

Upgrade API server integration tests to use Fake Petstore spec #5419

Open
#5,420 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature List: API servers help wanted Server: C-Sharp Server: Erlang Server: Go Server: Haskell Server: Java Server: Nodejs Server: Perl Server: PHP Server: Python Server: Ruby Server: Scala Server: Spring
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

petstore-with-fake-endpoints-models-for-testing.yaml covers a lot more edge cases when comparing with the original one (petstore.yaml)

We'll need to to update petstore.yaml with petstore-with-fake-endpoints-models-for-testing.yaml so to ensure the edge cases are covered moving forward.

API servers using petstore-with-fake-endpoints-models-for-testing.yaml:

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

If anyone wants to work on the enhancement, please reply to let us know. Thank you!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare petstore.yaml with petstore-with-fake-endpoints-models-for-testing.yaml in modules/swagger-codegen/src/test/resources/2_0. Review the listed API server integration tests and their spec references, then update each applicable server to use the fake spec. Done means the checklist integrations cover the additional edge cases and their tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, elixir, erlang, go, haskell, java, javascript, nodejs, php, python, ruby, scala, yaml
Domain
api, backend, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.