[PR #463] [CLOSED] Added OpenAPI support #602

New issue

Closed

opened 2026-02-25 23:34:52 +03:00 by kerem · 0 comments

kerem commented

2026-02-25 23:34:52 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/go-shiori/shiori/pull/463
Author: @Orhideous
Created: 8/8/2022
Status: ❌ Closed

Base: master ← Head: feature/api-overhaul

📝 Commits (10+)

29abe82 Use echo webserver to reduce boilerplate code
2baf089 Fix label in Dockerfile
f140b29 Described existing API with OpenAPI (without A/A by now)
61f5926 Set up foundations for future API with oapi-codegen
4fe26b5 There is already existing way to override data directory, so drop hardcoded one
909028b Remove useless code from Error response
5f6a625 Add database pool to ShioriServer struct
4ba7da8 Do not hardcode hosts for API
c5cc65c There is no need to represent IDs as signed integers
e162877 Add missed bookmarksCount

📊 Changes

15 files changed (+1344 additions, -60 deletions)

View changed files

📝 .github/workflows/_gorelease.yml (+1 -1)
📝 .github/workflows/_test.yml (+2 -2)
📝 .gitignore (+3 -0)
📝 Dockerfile (+1 -1)
📝 go.mod (+19 -4)
📝 go.sum (+76 -39)
➕ internal/api/accounts.go (+36 -0)
➕ internal/api/auth.go (+16 -0)
➕ internal/api/bookmarks.go (+41 -0)
➕ internal/api/generate.go (+4 -0)
➕ internal/api/server.go (+15 -0)
➕ internal/api/tags.go (+31 -0)
📝 internal/cmd/root.go (+0 -4)
📝 internal/webserver/server.go (+40 -9)
➕ openapi.yml (+1059 -0)

📄 Description

Relevant discussion: https://github.com/go-shiori/shiori/discussions/462

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/go-shiori/shiori/pull/463 **Author:** [@Orhideous](https://github.com/Orhideous) **Created:** 8/8/2022 **Status:** ❌ Closed **Base:** `master` ← **Head:** `feature/api-overhaul` --- ### 📝 Commits (10+) - [`29abe82`](https://github.com/go-shiori/shiori/commit/29abe82ff460410e01cecb296725744680f73eae) Use echo webserver to reduce boilerplate code - [`2baf089`](https://github.com/go-shiori/shiori/commit/2baf089df9f390a1453213ab6e7ecef7bfef4e06) Fix label in Dockerfile - [`f140b29`](https://github.com/go-shiori/shiori/commit/f140b29635c76921ce978224512c152a40c8a00f) Described existing API with OpenAPI (without A/A by now) - [`61f5926`](https://github.com/go-shiori/shiori/commit/61f59266e4da9a3982d5dfc3532d9f20b2483059) Set up foundations for future API with oapi-codegen - [`4fe26b5`](https://github.com/go-shiori/shiori/commit/4fe26b535c3f220d76d3a3f0da02af2fc7006f4a) There is already existing way to override data directory, so drop hardcoded one - [`909028b`](https://github.com/go-shiori/shiori/commit/909028b8c42763bda6668ee946896c638e7b09cd) Remove useless code from Error response - [`5f6a625`](https://github.com/go-shiori/shiori/commit/5f6a6259a974bbce9943645040c486fff6cf8de2) Add database pool to ShioriServer struct - [`4ba7da8`](https://github.com/go-shiori/shiori/commit/4ba7da868a7a1f1aa01d89c1cfb2924ddf25c992) Do not hardcode hosts for API - [`c5cc65c`](https://github.com/go-shiori/shiori/commit/c5cc65c54cc7483fd69e4c97d3a20a65beb26e6a) There is no need to represent IDs as signed integers - [`e162877`](https://github.com/go-shiori/shiori/commit/e16287763b19f45cba514cf914d5bc86ffa159b2) Add missed bookmarksCount ### 📊 Changes **15 files changed** (+1344 additions, -60 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/_gorelease.yml` (+1 -1) 📝 `.github/workflows/_test.yml` (+2 -2) 📝 `.gitignore` (+3 -0) 📝 `Dockerfile` (+1 -1) 📝 `go.mod` (+19 -4) 📝 `go.sum` (+76 -39) ➕ `internal/api/accounts.go` (+36 -0) ➕ `internal/api/auth.go` (+16 -0) ➕ `internal/api/bookmarks.go` (+41 -0) ➕ `internal/api/generate.go` (+4 -0) ➕ `internal/api/server.go` (+15 -0) ➕ `internal/api/tags.go` (+31 -0) 📝 `internal/cmd/root.go` (+0 -4) 📝 `internal/webserver/server.go` (+40 -9) ➕ `openapi.yml` (+1059 -0) </details> ### 📄 Description Relevant discussion: https://github.com/go-shiori/shiori/discussions/462 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>