scanapi / examples Goto Github PK

Description

Add a CONTRIBUTING.md file that links to the org's one: https://github.com/scanapi/contributors/blob/master/CONTRIBUTING.md

Increase maximum elapsed time on snippets-api::get_token response time test. Sometimes the API does not responds under a second and it makes the CI of the scanapi main repo fails:

https://github.com/scanapi/scanapi/pull/479/checks?check_run_id=3223647379

Remove empty body from the examples

Improve PokèAPI example

Current we have the PokèAPI example, but it only specifies two requests: https://pokeapi.co/api/v2/pokemon and https://pokeapi.co/api/v2/${pokemon_name}. It would be nice to have more requests specified.

PokèAPI API documentation

Create an example using spec in multiple files.

Current, we only have examples where the specification is only in a single file api.yaml. It would be nice to have one example with multiple files specification:

API specification in multiple files

With !include, it is possible to build your API specification in multiple files.

For example, these two files

# api.yaml
api:
  endpoints:
    - name: scanapi-demo
      path: ${BASE_URL}
      requests: !include include.yaml

# include.yaml
- name: health
  path: /health/

would generate:

api:
  endpoints:
    - name: scanapi-demo
      path: ${BASE_URL}
      requests:
        - name: health
          path: /health/

Description

Add a CODE_OF_CONDUCT.md file that links to the org's one: https://github.com/scanapi/contributors/blob/master/CODE_OF_CONDUCT.md

Add an example that uses delay key

Description

Improve the demo-api example

• Add tests
• Hide token

Description

The demo-api is going to be recreated scanapi/demo-api#16. We need to update the scanapi specification to match it.

Currently, we have two examples:

• PokèAPI
• Demo API

It would be nice to have more examples using other APIs. Specially APIs that implements a great variety of HTTP methods: get, post, patch, delete, put...

Add a README.md to scanapi-demo folder explaining how to run it:

• install scanapi
• run source .env to export the env vars

Please, see scanapi/scanapi#214