AIP Go

Go SDK for implementing Google API Improvement Proposals (AIP).

Generate AIP support code from proto

go install go.einride.tech/aip/cmd/protoc-gen-go-aip

Add to buf.gen.yaml:

version: v2
plugins:
  - local: protoc-gen-go-aip
    out: gen
    opt:
      - paths=source_relative

Run buf build to generate e.g. your_service_aip.go.

Library usage examples

go get -u go.einride.tech/aip

AIP-132 (Standard method: List)

• Use pagination.PageToken to implement offset-based pagination.

```go package examplelibrary

import ( "context"

  "go.einride.tech/aip/pagination"
  "google.golang.org/genproto/googleapis/example/library/v1"
  "google.golang.org/grpc/codes"
  "google.golang.org/grpc/status"

)

func (s Server) ListShelves( ctx context.Context, request library.ListShelvesRequest, ) (*library.ListShelvesResponse, error) { // Handle request constraints. const ( maxPageSize = 1000 defaultPageSize = 100 ) switch { case request.PageSize < 0: return nil, status.Errorf(codes.InvalidArgument, "page size is negative") case request.PageSize == 0: request.PageSize = defaultPageSize case request.PageSize > maxPageSize: request.PageSize = maxPageSize } // Use pagination.PageToken for offset-based page tokens. pageToken, err := pagination.ParsePageToken(request) if err != nil { return nil, status.Errorf(codes.InvalidArgument, "invalid page token") } // Query the storage. result, err := s.Storage.ListShelves(ctx, &ListShelvesQuery{ Offset: pageToken.Offset, PageSize: request.GetPageSize(), }) if err != nil { return nil, err } // Build the response. response := &library.ListShelvesResponse{ Shelves: result.Shelves, } // Set the next page token. if result.HasNextPage { response.NextPageToken = pageToken.Next(request).String() } // Respond. return response, nil } ```