Skip to content
API Improvement Proposals. https://aip.dev/
CSS HTML JavaScript Ruby Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github [AIP-3001]: Create AoG AIP block and AIP 3001. (#319) Oct 8, 2019
_includes [fix] Remove /home from the user click flow. (#343) Oct 22, 2019
_layouts Added search box placeholder text (#228) Aug 1, 2019
_sass Add spacing beneath headers. (#286) Sep 16, 2019
aip Fix small grammatical errors in AIP-194 (#357) Nov 15, 2019
assets [feat] Remove the state column, replace with a badge. (#244) Aug 15, 2019
support [fix] Allow partial word match in search. (#194) Jul 25, 2019
.dockerignore [chore] Add a Docker image for local work. May 6, 2019
.gitignore [chore] Add .gitignore appropriate for a Jekyll project. May 6, 2019
.prettierignore [feat] Remove the state column, replace with a badge. (#244) Aug 15, 2019
.prettierrc.yaml [chore] Add prettier configuration. May 6, 2019
CNAME Create CNAME May 13, 2019
CONTRIBUTING.md [chore] Add prettier configuration. May 6, 2019
Dockerfile [chore] Add a Docker image for local work. May 6, 2019
Gemfile [feat] Add Jekyll, and layout artifacts. May 6, 2019
Gemfile.lock [security] Bump nokogiri from 1.10.1 to 1.10.4 (#254) Aug 21, 2019
LICENSE.md [chore] Add license and contributing files. May 6, 2019
README.md [fix] Fix contributing link in README (#141) Jun 14, 2019
_config.yml Updated landing page to have buttons and such (#227) Aug 1, 2019
favicon.ico [feat] Add Jekyll, and layout artifacts. May 6, 2019
index.md [fix] Remove /home from the user click flow. (#343) Oct 22, 2019
overview.md Updated landing page to have buttons and such (#227) Aug 1, 2019
serve.sh [chore] Add a Docker image for local work. May 6, 2019

README.md

API Improvement Proposals

TL;DR: AIPs are lots of documents on how Google does APIs.

Overview

AIP stands for API Improvement Proposal, which is a design document providing high-level, concise documentation for API development. The goal is for these documents to serve as the source of truth for API-related documentation at Google and the way API teams discuss and come to consensus on API guidance. The program is named and styled after Python's enhancement proposals (PEPs) which have seemed to work pretty well over the years.

Specific areas inside Google

While much of the API-related guidance is general and spans across all the different products at Google, we've found that some teams working in different areas may have different customs, styles, or guidance. To accommodate these historical differences, we've provided separate blocks of numbers for those areas where they might override or extend the more general guidance.

Getting started

New to AIPs?

If you're new to AIPs, check out the Frequently Asked Questions which answer some common questions about how AIPs work and what you need to know.

Want to use this in your company?

If you like what you see and want to adopt the general AIPs for your organization, check out our guide on Adopting AIPs in your company. This guide walks you through how to start using AIPs and write your own guidance specific to your organization.

Have an idea for an AIP?

If you have an idea for an AIP that isn't written yet (yes, there are plenty!) check out Contributing to the project to see how you can write AIPs for others to follow.

License

Except as otherwise noted, the content of this repository is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.

For the full text of each license, see LICENSE.md. For additional details, see the developer.google.com Site Policies.

You can’t perform that action at this time.