An open API service indexing awesome lists of open source software.

https://github.com/gaprogman/bookapi

An API and UI for a fake book search engine - built entirely in the open, on Twitch
https://github.com/gaprogman/bookapi

Last synced: about 1 month ago
JSON representation

An API and UI for a fake book search engine - built entirely in the open, on Twitch

Awesome Lists containing this project

README

          

# bookApi

An API and UI for a fake book search engine

## Build Status

![.NET](https://github.com/GaProgMan/bookApi/workflows/.NET/badge.svg)

## Code of Conduct

Please ensure that you are familiar with the [code of conduct](./code-of-conduct.md) and the [contributions guide](./.github/contributing.md) before submitting any contributions or making any comments.

## API Roadmap

The following points are based on the [API Specification](./documentation/api-spec.md)

- [x] GET; returns a single Book record - [Issue #1](https://github.com/GaProgMan/bookApi/issues/1)
- [x] GET; returns a paged set of Book records - [Issue #2](https://github.com/GaProgMan/bookApi/issues/2)
- [ ] POST; takes a new Book record; returns the ID of the new record
- [ ] PUT; takes an ID and fields to update; returns the ID of the updated record
- [ ] DELETE; takes an ID and deletes a matching record; does not return anything
- [ ] Data storage for records; records and changes are not currently stored - tech TBC

## UI Roadmap

TBC