skills.rest
markacianfrani
markacianfraniCOMMUNITY
Explore all skills by this author →
Website𝕏@markacianfraniGitHub

become-rest-client

Audit live API implementations against OpenAPI specifications for contract violations.

6|Updated Jan 14, 2026
Search Tags:#api#openapi#qa#audit#rest#swagger
One-click install
npx skills add https://github.com/markacianfrani/armor --skill become-rest-client
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: become-rest-client
Source: https://github.com/markacianfrani/armor/tree/main/skills/become-rest-client
Command: npx skills add https://github.com/markacianfrani/armor --skill become-rest-client

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires restish, jq, yq, and includes scripts (resource) components.

What problem does it solve?

This Skill bridges the gap between API documentation and actual server behavior, identifying discrepancies where the implementation fails to match the contract.

Core Features & Use Cases

  • Automated Contract Auditing: Automatically verifies that server responses, status codes, and headers align with OpenAPI/Swagger specifications.
  • Gap Analysis: Detects undocumented endpoints or behaviors that deviate from the provided API contract.
  • Use Case: Use this when onboarding a new microservice or preparing for a release to ensure the API implementation is robust and fully compliant with its documented schema.

Quick Start

Run the become-rest-client skill by providing the path to your OpenAPI spec file and the base URL of the server you wish to audit.

Frequently Asked Questions about become-rest-client

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit live API responses against an OpenAPI spec?▼

You can audit live APIs against OpenAPI specifications by spawning subagents to perform targeted requests and verify that server responses, status codes, and headers align with the documented contract.

How do I find undocumented endpoints in my REST API?▼

Finding undocumented endpoints requires gap analysis against your API contract. This skill detects undocumented behaviors and endpoints that deviate from the provided OpenAPI or Swagger specification.

Do I need restish, jq, and yq to validate API contracts?▼

Yes, validating API contracts with this skill requires restish, jq, and yq to manage API registrations and parse OpenAPI specification files for validation.

Can I use this for QA testing before a microservice release?▼

Yes, you can use this for QA testing before a microservice release. It prepares your API by verifying the implementation is robust and fully compliant with its documented schema.

What's the best way to automate Swagger contract compliance checks?▼

Automating Swagger contract compliance checks involves verifying server responses against specification operation tags. This skill facilitates automated QA workflows by spawning subagents for targeted requests.

Why does my API response not match the OpenAPI specification?▼

If your API response does not match the OpenAPI specification, this skill identifies contract violations and discrepancies where the server behavior fails to match the documented schema.

Related Skills

Explore More Software Engineering Skills→
oakossoakoss
14

openapi

Design, validate, and document RESTful APIs using OpenAPI 3.1.

Official
Intermediate
Fr-e-dFr-e-d
157

remediate-failures

Apply minimal fixes to QA failures and iterate until quality gates pass.

Community
Advanced
1Mangesh11Mangesh1
3

jq-yq

Parse and transform JSON and YAML data using jq and yq.

Community
Intermediate
SalesforceCommerceCloudSalesforceCommerceCloud
51

b2c-custom-api-development

Design and deploy Custom SCAPI endpoints for B2C Commerce.

Official
Advanced