Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 826 Bytes

openapi.md

File metadata and controls

15 lines (12 loc) · 826 Bytes
Raw

OpenAPI Schema

To test a RESTful API, EvoMaster requires the presence of a schema. There are different ways to write API schemata, where OpenAPI is arguably the most common and used. Such format (previously called Swagger) is supported by EvoMaster, both v2 and v3.

If your API does not have such a schema, you have two options:

  1. Write it by hand.
  2. Use a tool to automatically generate it from your source code.

This latter option depends on which language and frameworks you are using to implement your API. For example, for Spring applications, you can look at SpringDoc. Adding a schema then is as easy as just adding such dependency to the classpath. Then, the schema will be accessible on the endpoint /v3/api-docs.