Integration guide

Add DocsCI alongside Postman Collections

DocsCI doesn't replace Postman. Postman/Newman tests your API endpoints. DocsCI tests your documentation — the code examples your developers copy-paste. These are different problems, and you should run both.

The gap Postman leaves: Newman verifies that POST /users returns 201. DocsCI verifies that the curl -X POST https://api.example.com/users example in your quickstart guide actually works, and that documented parameters match the OpenAPI spec.

Your current CI + DocsCI

Current CI (Newman only):

# Your current CI (Newman)
- name: API tests (Newman)
  run: |
    npx newman run postman-collection.json \
      --environment postman-env.json \
      --reporters cli,junit \
      --reporter-junit-export results.xml

Add DocsCI in parallel:

# Combined CI: Newman + DocsCI
- name: API tests (Newman)
  run: |
    npx newman run postman-collection.json \
      --environment postman-env.json

# DocsCI runs in parallel — tests DOCUMENTATION, not API
- name: Docs tests (DocsCI)
  run: |
    tar czf docs.tar.gz docs/ *.md 2>/dev/null || tar czf docs.tar.gz docs/
    curl -sf -X POST https://snippetci.com/api/runs/queue \
      -H "Authorization: Bearer ${{ secrets.DOCSCI_TOKEN }}" \
      -F "docs_archive=@docs.tar.gz" \
      -F "openapi_url=${{ vars.OPENAPI_URL }}" \
    | jq -e '.status == "passed"'

What DocsCI adds to your stack

Coverage areaPostman/NewmanDocsCI
API endpoint contract testing✓Partial
Code examples in Markdown docs✗✓
Multi-language SDK snippets (JS, Python, Go)✗✓
OpenAPI spec vs docs drift✗✓
Accessibility checks on doc pages✗✓
Copy quality (passive voice, sensitive terms)✗✓
Pre-execution secret scanning✗✓
PR inline comments with AI fixes✗✓
Mock servers✓✗
Performance/load testing✓✗

Setup steps

1

Create a DocsCI account

snippetci.com/signup — free tier, no credit card.
2

Add DOCSCI_TOKEN secret

GitHub Settings → Secrets → Actions → New secret. Name it DOCSCI_TOKEN.
3

Copy the DocsCI step

Add the DocsCI step from the snippet above to your existing GitHub Actions workflow. It runs in parallel with Newman.
4

Configure OpenAPI drift (optional)

Add your OpenAPI spec URL as a variable: vars.OPENAPI_URL. DocsCI will diff documented params against the spec.
GitHub Actions →DocsCI vs Postman →