API Development

This document is a top-level entry point to documentation related to developing APIs for Fuchsia.

What this covers

Although the documentation in this directory applies to all Fuchsia APIs, it will be enforced for the public facing surface area of Fuchsia: the Fuchsia APIs that are surfaced to developers via IDK releases. All public facing API changes will be reviewed by the API Council for consistency with these guidelines.

Guidelines

Before you begin working on a Fuchsia API, it is important to understand how an API is versioned in Fuchsia:

• Fuchsia API evolution guidelines

Rubrics

The documentation in this directory comes in the form of rubrics, which are established protocols for how to design and build APIs. Note that the list below is not complete: as Fuchsia evolves, more rubrics will be added.

• API Documentation
• CLI and GUI tools
  • Developer tool guidelines
  • Command-line tools rubric)
  • CLI tool help requirements
• Languages
  • C API Readability
  • FIDL Style
  • FIDL API
  • Go rubric
  • Rust rubric
• Domain-specific areas
  • Zircon System Interface