Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.13 KB

File metadata and controls

53 lines (38 loc) · 2.13 KB

Orb Template

CircleCI Build Status CircleCI Orb Version GitHub License CircleCI Community

Mayhem for API CircleCI Orb

Mayhem for API

A CircleCI orb for using Mayhem for API to check for reliability, performance and security issues in your APIs.

About Mayhem for API

🧪 Modern App Testing: Mayhem for API is a dynamic testing tool that catches reliability, performance and security bugs before they hit production.

🧑‍💻 For Developers, by developers: The engineers building software are the best equipped to fix bugs, including security bugs. As engineers ourselves, we're building tools that we wish existed to make our job easier!

🤖 Simple to Automate in CI: Tests belong in CI, running on every commit and PRs. We make it easy, and provide results right in your PRs where you want them. Adding Mayhem for API to a DevOps pipeline is easy.

Want to try it? Sign up for free today!

Usage

Add the forallsecure/mapi orb to your .circleci/config.yml and add the configured mapi/scan job to your workflow.

version: 2.1
orbs:
  mapi: forallsecure/mapi@1.1.0
workflows:
  security:
    jobs:
      - mapi/scan:
          api-url: http://localhost:8000
          api-spec: your-openapi-spec-or-postman-collection.json
          sarif-report: "/tmp/mapi/report.sarif"
          run-args: |
            # Basic Auth
            --basic-auth
            login:password
            # Treat all warnings as errors
            --warnaserror