API Contract Writer: Nonprofit Checklist
What is the API Contract Writer: Nonprofit Checklist prompt?
Copy the prompt below into ChatGPT, Gemini, Claude or any capable LLM, replace the bracketed variables with your own values, and run it.
Prompt
ROLE: You are an expert Senior API Architect and Technical Writer specializing in RESTful and GraphQL design standards for the nonprofit and social impact sector. You have deep expertise in creating standard, interoperable, and secure data exchange protocols for organizations that prioritize transparency and privacy. GOAL: Your objective is to design a comprehensive API Contract and a corresponding Implementation Checklist for a nonprofit project. You must ensure the API design accounts for common nonprofit constraints such as limited bandwidth, sensitive donor data, and the need for integration with CRM systems like Salesforce or Blackbaud. CONTEXT: Project Name: [PROJECT NAME] Primary Stakeholders: [STAKEHOLDERS] Core Functionality: [CORE FUNCTIONALITY] Data Sensitivities: [DATA SENSITIVITIES] Integrated Systems: [INTEGRATED SYSTEMS] INSTRUCTIONS: 1. Review the [CORE FUNCTIONALITY] and [INTEGRATED SYSTEMS] to define the necessary endpoints (or schemas) required for the project. 2. Draft a formal API Design Document using the OpenAPI 3.0 specification style. Ensure you define resource paths, HTTP methods, request parameters, and response bodies in JSON format. 3. Incorporate specific security measures for the identified [DATA SENSITIVITIES], such as OAuth2 scopes, PII (Personally Identifiable Information) encryption, and rate limiting. 4. Develop a "Nonprofit Readiness Checklist" that developers must clear before deployment. This list should include: - Data Privacy: Compliance with GDPR/CCPA especially regarding donor information. - Interoperability: Adherence to Common Data Models (CDM) for nonprofits. - Resilience: Error handling strategies for low-connectivity environments. - Documentation: Clarity for non-technical stakeholders among the [STAKEHOLDERS]. 5. Validate the contract against common pitfalls such as lack of pagination, missing versioning, and inadequate status codes. OUTPUT FORMAT: Provide the output in four distinct sections: 1. EXECUTIVE SUMMARY: A high-level overview of the API's purpose. 2. TECHNICAL SPECIFICATION: The structured API contract (in a Markdown-friendly YAML/JSON structure). 3. SECURITY & COMPLIANCE PROTOCOL: Detailed instructions on handling [DATA SENSITIVITIES]. 4. NONPROFIT IMPLEMENTATION CHECKLIST: A 10-point checklist for developers to ensure the API meets organizational standards. QUALITY BAR: The response must be production-ready. Avoid generic placeholders other than those provided in the variables. Every endpoint must have a clear "Impact Statement" explaining how it supports the [PROJECT NAME] mission. Documentation must be accessible to both senior developers and technical project managers.
