Skip to content

Article - tools for api testing 2025#75

Merged
themattwilliams merged 21 commits intomainfrom
mw-article-tools-for-api-testing-2025
Aug 30, 2025
Merged

Article - tools for api testing 2025#75
themattwilliams merged 21 commits intomainfrom
mw-article-tools-for-api-testing-2025

Conversation

@themattwilliams
Copy link
Contributor

@themattwilliams themattwilliams commented Aug 18, 2025

What/Why/How?

  • What: Adds and refines the Learn article learn/testing/tools-for-api-testing-in-2025.md (lead‑in box, “Aha” mini‑story, decision guides, comparison matrix, metrics section with targets/how‑to, prerequisites, diagram captions, links to CLI commands and related learn content).
  • Why: Improve engagement and scannability; align with our storytelling framework; provide a clear decision path for API testing tools and “contract testing vs functional testing.”
  • How: Edited the article content, added internal cross‑links, clarified terminology (CDCT, SLOs), fixed typos, added outcome metrics and a primary CTA.

Reference

  • Storytelling framework: https://github.com/themattwilliams/redocly-content/blob/main/process/2-creation/frameworks/storytelling_creation_framework.md
  • Related Learn pages:
    • /learn/testing/contract-testing-101
    • /learn/arazzo/testing-arazzo-workflows
  • CLI docs:
    • /docs/cli/rules/built-in-rules
    • /docs/cli/commands/lint
    • /docs/cli/commands/generate-arazzo
    • /docs/cli/commands/respect

Testing

  • Lint: ran markdownlint; no warnings.
  • Local preview (suggested):
    • npm i (first time)
    • npx @redocly/cli preview
    • Verify page at /learn/testing/tools-for-api-testing-in-2025
    • Check links resolve (CLI commands, learn cross‑links)
    • Confirm Mermaid diagrams render
    • Confirm it appears in Learn Testing landing and Learning Center card

Screenshots (optional)

  • None

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered (content only; no runtime changes)
  • Code follows company security practices and guidelines (links to internal docs; no new scripts)

Matt Williams added 2 commits August 18, 2025 14:22
…bar and index; add cross-link from Contract Testing 101; update Learning Center card
…rix, add Aha mini-story, expand metrics section with targets and how-to; link CLI rules and commands
themattwilliams and others added 4 commits August 18, 2025 17:59
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
themattwilliams and others added 11 commits August 18, 2025 18:04
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
…configurable rule syntax, terminology (OpenAPI description), heading structure, Choose-this clarity, and remove trailing whitespace
Co-authored-by: Adam Altman <adam@redocly.com>
…markdoc table syntax

made improvements based on feedback
@themattwilliams
Copy link
Contributor Author

@adamaltman updates/improvements implemented

@themattwilliams
Copy link
Contributor Author

updated paths, anchor text, and strange phantom "CTA" header.

@themattwilliams themattwilliams merged commit 4fb2467 into main Aug 30, 2025
4 of 5 checks passed
@themattwilliams themattwilliams deleted the mw-article-tools-for-api-testing-2025 branch August 30, 2025 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants