diff --git a/README.md b/README.md index c819e43..3e89db5 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,36 @@ All the vulnerabilities detected by the project are listed at this URL: ## Example usage +### Using OpenAPI + +```yaml +name: Scan for API vulnerabilities + +on: [push] + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: VulnAPI + uses: cerberauth/vulnapi-action@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + openapi: 'openapi.yaml' +``` + +### Using Curl + ```yaml -name: VulnAPI +name: Scan for API vulnerabilities on: [push] @@ -55,8 +83,7 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: - curl: - 'curl http://localhost:8080 -H "Authorization: Bearer eyJhbGci..."' + curl: 'curl http://localhost:8080 -H "Authorization: Bearer eyJhbGci..."' ``` ## Inputs