Skip to content
Permalink
Browse files

Merge branch 'master' into split_files

  • Loading branch information
bogdanmarculescu committed Jan 10, 2020
2 parents 2949525 + be93d2f commit 329cfbca13267950641f01dbc539b5003c6df839
Showing with 18 additions and 2 deletions.
  1. +3 −2 README.md
  2. +15 −0 docs/openapi.md
@@ -150,6 +150,7 @@ At the moment, _EvoMaster_ supports _H2_ and _Postgres_ databases.
* [Download EvoMaster](docs/download.md)
* [Build EvoMaster from source](docs/build.md)
* [Console options](docs/options.md)
* [OpenApi/Swagger Schema](docs/openapi.md)
* [Using EvoMaster for Black-Box Testing (easier to setup, but worse results)](docs/blackbox.md)
* [Using EvoMaster for White-Box Testing (harder to setup, but better results)](docs/whitebox.md)
* [Write an EvoMaster Driver for White-Box Testing](docs/write_driver.md)
@@ -219,8 +220,8 @@ the [issues](https://github.com/EMResearch/EvoMaster/issues) page:
### Funding

_EvoMaster_ has been funded by:
* 2020-2026: a 2 million Euro grant by the European Research Council (ERC),
as part of the ERC Consolidator project
* 2020-2025: a 2 million Euro grant by the European Research Council (ERC),
as part of the *ERC Consolidator* project
<i>Using Evolutionary Algorithms to Understand and Secure Web/Enterprise Systems</i>.
* 2018-2021: a 7.8 million Norwegian Kroner grant by the Research Council of Norway (RCN),
as part of the Frinatek project <i>Evolutionary Enterprise Testing</i>.
@@ -0,0 +1,15 @@
# OpenAPI Schema

To test a RESTful API, _EvoMaster_ requires the presence of a schema.
There are different ways to write API schemata, where [OpenAPI](https://www.openapis.org/) 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](https://github.com/springdoc/springdoc-openapi).
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`.

0 comments on commit 329cfbc

Please sign in to comment.
You can’t perform that action at this time.