Skip to content
A linter for APIs defined in protocol buffers.
Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci [refactor] Shorten documentation URLs. (#343) Nov 14, 2019
.github Add CODEOWNERS file. (#246) Oct 18, 2019
cmd/api-linter Added AIP number in rule register function. (#330) Nov 11, 2019
docs [AIP-140] Permit order_by and group_by. (#350) Nov 15, 2019
lint [cleanup] Fix errors returned by staticcheck. (#331) Nov 14, 2019
locations [feat] Add location method for the HTTP rule. (#346) Nov 15, 2019
rules [AIP-140] Permit order_by and group_by. (#350) Nov 15, 2019
.editorconfig Add EditorConfig (#133) Aug 6, 2019
.gitignore [feat] Linter documentation in GitHub Pages. (#263) Oct 31, 2019
LICENSE [chore] Change the license to Apache 2.0. (#60) May 13, 2019
README.md [cleanup] Move domain to linter.aip.dev. (#342) Nov 13, 2019
go.mod [chore] Update google.golang.org/genproto commit hash to 83cc047 (#353) Nov 15, 2019
go.sum

README.md

Google API Linter

The API linter provides real-time checks for compliance with many of Google's API standards, documented using API Improvement Proposals. It operates on API surfaces defined in protocol buffers.

It identifies common mistakes and inconsistencies in API surfaces:

// Incorrect.
message GetBookRequest {
  // This is wrong; it should be spelled `name`.
  string book = 1;
}

When able, it also offers a suggestion for the correct fix.

Read more ≫

License

This software is made available under the Apache 2.0 license.

You can’t perform that action at this time.