Functional List

What is a Functional List ?

Functional List serves as a central registry for all the APIs created within your project. It's designed to go beyond a simple list of endpoints by allowing you to enrich each API with crucial metadata, development guidelines, and difficulty levels. This transforms it into an intelligent hub for managing, documenting, and preparing your APIs for AI-powered code generation.

functional list

Key Capabilities

  1. Centralized API Registry - The list automatically aggregates every API endpoint you've built, providing a single, comprehensive view. You can easily search and filter by the API URL path to quickly find what you need.
  2. Difficulty Level Assignment - You can assign a priority level to each API (e.g., High, Medium or Low). This helps in organizing development workflows, planning sprints, and allocating resources based on the complexity or importance of each endpoint.
  3. Detailed Conventions - For each API, you can specify detailed implementation guidelines and business logic:
  • Frontend Conventions: Requirement how the system should be consumed by the user interface, including rules for data handling, state management, and user interaction.
  • Backend Conventions: Detail the server-side business logic, data validation rules, security checks, and any other processes that need to be executed when the endpoint is called.
  1. Design Integration (Figma Link) - You can link each API directly to its corresponding Figma design file. This creates a seamless connection between the visual design, the user experience, and the technical specification, ensuring that developers are building the right feature.
figma link