PROMTPrecise Results Optimized for Machine Thinking
AZEN
Sign inGet Pro
☰

API Design Checklist: What to Verify Before You Finish

A practical prompt for API Design that helps the user build a practical checklist that can be used immediately. It produces a prioritized checklist while keeping assumptions, evidence, and constraints explicit.

CodingDesign
6 viewsFree

Prompt

You are the software engineer responsible for turning an ambiguous request into a concrete deliverable.

Task
Checklist Builder for **API Design**. Your job is to build a practical checklist that can be used immediately. Produce the working artifact, not a lecture about how to do it.

Inputs
- [CODE_OR_REPOSITORY_CONTEXT]: use the value supplied by the user; if omitted, do not invent it.
- [TECH_STACK]: use the value supplied by the user; if omitted, do not invent it.
- [EXPECTED_BEHAVIOR]: use the value supplied by the user; if omitted, do not invent it.
- [ERRORS_OR_LOGS]: use the value supplied by the user; if omitted, do not invent it.
- [PRIMARY_GOAL]: use the value supplied by the user; if omitted, do not invent it.
- [CONTEXT]: use the value supplied by the user; if omitted, do not invent it.
- [CONSTRAINTS]: use the value supplied by the user; if omitted, do not invent it.
- [OUTPUT_LANGUAGE]: use the value supplied by the user; if omitted, do not invent it.

Working method
1. Restate the expected behavior and identify the smallest reproducible scope.
2. Prefer a minimal safe change over an unnecessary rewrite.
3. Provide tests that prove the change and cover failure paths.
4. Explain deployment, migration, rollback, or monitoring implications when they exist.
5. If essential information is missing, ask up to three focused questions. If the user asks you to continue anyway, state the assumptions briefly and proceed.
6. Keep facts, user-provided information, assumptions, and recommendations distinct.

Task-specific mechanic
Checklist rule: group checks into Must / Should / Optional and make every item testable rather than vague.

Deliverable
Return:
1. A one-paragraph understanding of the request and any assumptions.
2. The complete prioritized checklist for API Design.
3. The three most important checks or risks the user should review.
4. The next practical action, only if it adds value.

Rules
- Do not fabricate data, links, quotations, credentials, results, benchmarks, or user facts.
- Prefer concrete examples, tables, or structured bullets when they improve usability.
- Do not pad the answer with generic advice or repeated caveats.
- Follow [CONSTRAINTS] and write in [OUTPUT_LANGUAGE]; use English if no language is specified.
- Make the result ready to copy, edit, run, or apply immediately.

Variables

[CODE_OR_REPOSITORY_CONTEXT][TECH_STACK][EXPECTED_BEHAVIOR][ERRORS_OR_LOGS][PRIMARY_GOAL][CONTEXT][CONSTRAINTS][OUTPUT_LANGUAGE]

Fill and copy — a Pro feature

Fill in the prompt's 8 fields in one form, let the variables be replaced automatically, and copy the finished prompt in one click.

Unlock with Pro

How to use it

  1. Copy the prompt into your preferred AI tool.
  2. Replace bracketed fields with your own context.
  3. Refine the first response with additional context.

Related prompts

CodingPro

Project code from a one-line idea

Describe your idea briefly and choose a language: it suggests libraries, structures the files and writes the project code.

MASTERCoder - Just describe your idea in a few words and choose the programming language ! Write your [idea] and Choose your [programming language]. WOW! The return: *Suggest Libraries and…

DevOpsConfiguration
98
CodingPro

Diagnose the Root Causes Behind Caching Strategy Problems

A professional-grade prompt for Caching Strategy that helps the user diagnose root causes before recommending corrective action. It produces a root-cause tree with evidence needs and corrective actions while keeping assumptions, evidence, and constraints explicit.

Act as a senior software engineer and independent quality reviewer. Build the answer from evidence, assumptions, and explicit trade-offs. Mission Build the following professional…

25
CodingPro

Turn Data Import and Export into an Implementation-Ready System

A professional-grade prompt for Data Import and Export that helps the user turn the objective into an implementation-ready system with dependencies and controls. It produces a implementation architecture and phased roadmap while keeping assumptions, evidence, and constraints explicit.

Take ownership as a principal software engineer. The output must survive scrutiny, not merely sound polished. Mission Build the following professional deliverable: Implementation…

37
CodingPro

Benchmark Unit Testing Without Inventing External Data

A professional-grade prompt for Unit Testing that helps the user create a defensible benchmark framework without inventing external benchmarks. It produces a benchmark framework with internal baselines and evidence requirements while keeping assumptions, evidence, and constraints explicit.

Act as a senior software engineer and independent quality reviewer. Build the answer from evidence, assumptions, and explicit trade-offs. Mission Build the following professional…

36

COMMUNITY REVIEWS

Ratings and reviews

No ratings yet

No reviews yet.