mirror of
https://github.com/go-shiori/shiori.git
synced 2024-09-20 23:16:12 +08:00
6f19c12c95
* added 404 template * added auth domain * added embed file for frontend * added base config and dependencies * added basic new http server * added separated server command * updated go modules * removed modd file * Added shortcut to send internal server error response * Added JWT support to Auth Domain * Added JWT support to API * docs: added comments to response struct * naming * inline returns * updated dependencies * production logger * bookmarks endpoint * reverted old views api path * frontend for api v1 * proper 404 error (not working atm) * use response * removed 404 html * server error handler * login and basic auth * adjusted session duration * properly retrieve tags * properly delete bookmark * cleanup * archiver domain * debug routes * bookmark routes * expiration by parameter * move to logrus * logout * frontend cache * updated dependencies * http: migrated to gin * linted * Added version command * unit tests, docs * response test utils and tests * remove logout handler * auth * createtag * improved http test utilities * assert message equals * Remove 1.19 from test matrix * moved api to v1 folder * docs: contribute docs * updated makefile * updated usage docs * warn in server command * updaed docs with shiori version command * Updated documentation * deps: update
19 lines
1.2 KiB
Markdown
19 lines
1.2 KiB
Markdown
# API v1
|
||
|
||
> ℹ️ **This is the documentation for the new API. This API is still in development and though the finished endpoints should not change please consider that breaking changes may occur once its properly released. If you are looking for the current API, please [see here](./API.md).**
|
||
|
||
The new API is an ongoing effort to migrate the current API to a more modern and standard API.
|
||
|
||
The main goals of this new API are:
|
||
- Ease of development
|
||
- Use of a [modern framework](https://gin-gonic.com)
|
||
- Use of a [standard API specification](https://swagger.io/specification/)
|
||
- Self-documented API using [Swag](https://github.com/swaggo/swag)
|
||
- Improved authentication and sessions using [JWT](https://jwt.io)
|
||
- Deduplicate code between the webserver and the API by refactoring the logic into domains
|
||
- Improve testability by using interfaces and dependency injection
|
||
|
||
The current status of this new API can be checked [here](https://github.com/go-shiori/shiori/issues/640).
|
||
|
||
Since the API is self-docummented, you can check the API documentation by [running the server locally](./Contribute.md#running-the-server-locally) and visiting the [`/swagger/index.html` endpoint](http://localhost:8080/swagger/index.html).
|