add-api

Integrate external API providers with wrappers, tests, and documentation.

43|2|Updated Jan 25, 2024
One-click install
npx skills add https://github.com/glowingkitty/OpenMates --skill add-api-glowingkitty
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-api
Source: https://github.com/glowingkitty/OpenMates/tree/main/.agents/skills/add-api
Command: npx skills add https://github.com/glowingkitty/OpenMates --skill add-api-glowingkitty

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of integrating a new third-party API provider when developers lack reliable, up-to-date documentation and want a repeatable, privacy-aware process.

Core Features & Use Cases

  • Research-first provider integration: Guides you to gather official API documentation, key implementation details, and constraints before writing code.
  • Provider directory + clean module boundaries: Creates a dedicated backend/shared/providers/{provider_name}/ structure with a pure API wrapper (client.py) and typed schemas (models.py).
  • Testing and documentation scaffolding: Generates an API test script and a docs/apis/{provider_name}.md page including auth, endpoints, pricing/limits, and scaling notes.
  • Privacy and legal check: Prompts you to review and update privacy policy content if needed for the new provider.

Quick Start

Use the add-api Skill with the provider name you want to integrate, for example: integrate the openweathermap API.

Frequently Asked Questions about add-api

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

FAQPage Schema
How do I integrate a new external API safely with proper authentication and rate limiting?

To integrate a new external API safely, gather official documentation first, then design a provider-specific wrapper implementing authentication and rate limiting, followed by generating tests and verifying privacy compliance.

What is the best way to structure an API integration wrapper for async httpx calls?

The best way to structure an API integration wrapper is to create a dedicated provider directory containing a pure API client for async httpx calls and typed schemas, separating network logic from data models.

How do I load API secrets securely when integrating a third-party provider?

Load API secrets securely using a vault-first workflow with an environment variable fallback, ensuring sensitive credentials are fetched from a secure vault before defaulting to local environment configurations.

Does integrating a new API provider require updating privacy policies?

Integrating a new API provider requires a privacy and legal check, prompting you to review and update privacy policy content if the external service processes user data or changes data handling requirements.

Can I generate API documentation and test scaffolding automatically for a new provider integration?

You can generate API documentation and deterministic test scaffolding automatically by creating a dedicated docs page covering endpoints, pricing, and limits, alongside an API test script for the new provider.

What limitations should I check before adding a new third-party API?

Before adding a third-party API, verify limitations by researching endpoint constraints, rate limits, security requirements, and pricing tiers from official documentation to ensure the integration scales safely.