package endpoints.examples.bookstore

Get desktop application:
View/edit binary Protocol Buffers messages

A simple Bookstore API. The API manages shelves and books resources. Shelves contain books.

• rpc ListShelves (google.protobuf.Empty, ListShelvesResponse)

  bookstore.proto:33

  Returns a list of all shelves in the bookstore.

  message ListShelvesResponse

  bookstore.proto:69

  Response to ListShelves call.

  • repeated Shelf shelves = 1

    Shelves in the bookstore.

• rpc CreateShelf (CreateShelfRequest, Shelf)

  bookstore.proto:35

  Creates a new shelf in the bookstore.

  message CreateShelfRequest

  bookstore.proto:75

  Request message for CreateShelf method.

  • optional Shelf shelf = 1

    The shelf resource to create.

• rpc GetShelf (GetShelfRequest, Shelf)

  bookstore.proto:37

  Returns a specific bookstore shelf.

  message GetShelfRequest

  bookstore.proto:81

  Request message for GetShelf method.

  • int64 shelf = 1

    The ID of the shelf resource to retrieve.

• rpc DeleteShelf (DeleteShelfRequest, google.protobuf.Empty)

  bookstore.proto:39

  Deletes a shelf, including all books that are stored on the shelf.

  message DeleteShelfRequest

  bookstore.proto:87

  Request message for DeleteShelf method.

  • int64 shelf = 1

    The ID of the shelf to delete.

• rpc ListBooks (ListBooksRequest, ListBooksResponse)

  bookstore.proto:41

  Returns a list of books on a shelf.

  message ListBooksRequest

  bookstore.proto:93

  Request message for ListBooks method.

  • int64 shelf = 1

    ID of the shelf which books to list.

  message ListBooksResponse

  bookstore.proto:99

  Response message to ListBooks method.

  • repeated Book books = 1

    The books on the shelf.

• rpc CreateBook (CreateBookRequest, Book)

  bookstore.proto:43

  Creates a new book.

  message CreateBookRequest

  bookstore.proto:105

  Request message for CreateBook method.

  • int64 shelf = 1

    The ID of the shelf on which to create a book.

  • optional Book book = 2

    A book resource to create on the shelf.

• rpc GetBook (GetBookRequest, Book)

  bookstore.proto:45

  Returns a specific book.

  message GetBookRequest

  bookstore.proto:113

  Request message for GetBook method.

  • int64 shelf = 1

    The ID of the shelf from which to retrieve a book.

  • int64 book = 2

    The ID of the book to retrieve.

• rpc DeleteBook (DeleteBookRequest, google.protobuf.Empty)

  bookstore.proto:47

  Deletes a book from a shelf.

  message DeleteBookRequest

  bookstore.proto:121

  Request message for DeleteBook method.

  • int64 shelf = 1

    The ID of the shelf from which to delete a book.

  • int64 book = 2

    The ID of the book to delete.

A book resource.

Used as response type in: Bookstore.CreateBook, Bookstore.GetBook

Used as field type in: CreateBookRequest, ListBooksResponse

• int64 id = 1

  A unique book id.

• string author = 2

  An author of the book.

• string title = 3

  A book title.

A shelf resource.

Used as response type in: Bookstore.CreateShelf, Bookstore.GetShelf

Used as field type in: CreateShelfRequest, ListShelvesResponse

• int64 id = 1

  A unique shelf id.

• string theme = 2

  A theme of the shelf (fiction, poetry, etc).