You've seen what Mayhem for API can do in a demo. Now it's time to fuzz your own!
To start testing an API, you only need to provide two things: a specification describing the API, and a URL where it can be reached. You'll be running something like:
mapi run my-api 30 <specification> --url <url>
ℹ️ Specifications can be passed to
mapias either local files or URLs.
Mayhem for API is built around OpenAPI 3 specifications. If you have an OpenAPI spec describing your API, you're all set. Pass either a URL or file system path directly to mapi as the <specification> argument!
If you don't have an OpenAPI spec, we support a few alternatives, described below.
mapi run will automatically detect and work with older OpenAPI/Swagger specs.
Alternatively, you can do a one-time conversion into OpenAPI 3 by running your old spec through the mapi convert swagger2 command.
mapi run will also automatically detect if it's given a Postman 2.x collection in place of an OpenAPI spec, and work with that.
Alternatively, you can do a one-time conversion from Postman into an OpenAPI 3 spec by running the collection through the mapi convert postman command.
If you don't have any of the above, you'll need to do a little bit more work to generate a spec for Mayhem for API to use.
Mayhem for API needs to know the URL of your API server. Because the requests come directly from the mapi CLI tool running locally on your computer, this will work for APIs that are:
If the machine running the CLI can access the API - then we can fuzz it!
Although it'll work in just about any configuration, Mayhem for API works better the "closer" it is (in network terms) to the API server. For the best results, this means pointing the fuzzer at a locally-running instance of your server.
Mayhem for API has one job: finding ways to break an API! You should absolutely not give Mayhem for API the URL of your production services to test against.
Prime Your APIs for Performance ... In As Little As 5 Minutes.
All right, hopefully you've got Mayhem for API configured to test your API, congrats!
By submitting this form, you agree to our Terms of Use and acknowledge our Privacy Statement.
