Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrewzulaybar/books
📚 A backend proof of concept of a book management application.
https://github.com/andrewzulaybar/books
angular golang postgresql
Last synced: about 17 hours ago
JSON representation
📚 A backend proof of concept of a book management application.
- Host: GitHub
- URL: https://github.com/andrewzulaybar/books
- Owner: andrewzulaybar
- Created: 2020-05-09T06:28:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T19:10:30.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T20:06:33.539Z (5 months ago)
- Topics: angular, golang, postgresql
- Language: Go
- Homepage:
- Size: 1.64 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Documentation
All the endpoints available are listed below alongside the types of methods supported.
## Publication
A publication represents a specific edition of a work.
```
type Publication struct {
ID int `json:"id"`
EditionPubDate string `json:"editionPubDate"`
Format string `json:"format"`
ImageURL string `json:"imageUrl"`
ISBN string `json:"isbn"`
ISBN13 string `json:"isbn13"`
Language string `json:"language"`
NumPages int `json:"numPages"`
Publisher string `json:"publisher"`
Work work.Work `json:"work"`
}
```
- [**GET** /api/publication]: Retrieves the entire list of publications from the database.
- [**POST** /api/publication]: Creates an entry in the publication table with the given attributes.
- [**DELETE** /api/publication]: Removes the entries in the publication table matching the given ids.
- [**GET** /api/publication/:id]: Retrieves the publication from the database matching the given id.
- [**PATCH** /api/publication/:id]: Updates the entry in the database matching pub.id with the given attributes.
- [**DELETE** /api/publication/:id]: Removes the entries in the publication table matching the given ids.
## Work
A work represents a literary work.
```
type Work struct {
ID int `json:"id"`
Description string `json:"description"`
InitialPubDate string `json:"initialPubDate"`
OriginalLanguage string `json:"originalLanguage"`
Title string `json:"title"`
Author author.Author `json:"author"`
}
```
- [**GET** /api/work]: Retrieves the entire list of works from the database.
- [**POST** /api/work]: Creates an entry in the work table with the given attributes.
- [**DELETE** /api/work]: Removes the entry in the work table matching the given id.
- [**GET** /api/work/:id]: Retrieves the work from the database matching the given id.
- [**PATCH** /api/work/:id]: Updates the entry in the database matching work.id with the given attributes.
- [**DELETE** /api/work/:id]: Removes the entries in the work table matching the given ids.
## Author
An author represents a writer of a work.
```
type Author struct {
ID int `json:"id"`
FirstName string `json:"firstName"`
LastName string `json:"lastName"`
Gender string `json:"gender"`
DateOfBirth string `json:"dateOfBirth"`
PlaceOfBirth location.Location `json:"placeOfBirth"`
}
```
- [**GET** /api/author]: Retrieves the entire list of authors from the database.
- [**POST** /api/author]: Creates an entry in the author table with the given attributes.
- [**DELETE** /api/author]: Removes the entries in the author table matching the given ids.
- [**GET** /api/author/:id]: Retrieves the author from the database matching the given id.
- [**PATCH** /api/author/:id]: Updates the entry in the database matching author.id with the given attributes.
- [**DELETE** /api/author/:id]: Removes the entry in the author table matching the given id.