diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2018-05-09 11:12:04 -0700 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2018-05-09 11:12:16 -0700 |
| commit | 5af7dc8d208ed7f6fc61fef13b81d636e6e0dfcd (patch) | |
| tree | 0493a7b0212fe4fe43936efebc8d5ba91de2c82a | |
| parent | 351773cca98ccc61f7844ba9892ee797f1dd3d29 (diff) | |
| download | fatcat-x-attic-golang.tar.gz fatcat-x-attic-golang.zip | |
README updatesx-attic-golang
| -rw-r--r-- | fatcat-go/README.md | 3 | ||||
| -rw-r--r-- | notes/golang.txt | 14 |
2 files changed, 16 insertions, 1 deletions
diff --git a/fatcat-go/README.md b/fatcat-go/README.md index ea1166ce..408ee1a5 100644 --- a/fatcat-go/README.md +++ b/fatcat-go/README.md @@ -21,3 +21,6 @@ In early development, we'll make at least the following simplifications: - "extra" metadata is stored in-entity as JSONB. In the future this might be broken out to a separate table - libraries won't be vendored; in the future they will be via a git submodule + + +## Tools diff --git a/notes/golang.txt b/notes/golang.txt index 090a5942..0730f409 100644 --- a/notes/golang.txt +++ b/notes/golang.txt @@ -1,8 +1,9 @@ +## Database Schema / ORM / Generation + - pq: basic postgres driver and ORM (similar to sqlalchemy?) - sqlx: small extensions to builtin sql; row to struct mapping - code generation from SQL schema: - https://github.com/xo/xo - https://github.com/volatiletech/sqlboiler @@ -20,6 +21,17 @@ for auth, start with oauth2... orcid? debug postgres with gocmdpev +## OpenAPI/Swagger + +go-swagger (OpenAPI 2.0): +- generate initial API server skeleton from a yaml definition +- export updated yaml from code after changes +- web UI for documentation +- templating/references +- auto-generate client (in golang) + +also look at ReDoc as a UI; all in-brower generated from JSON (react) + ## Non-API stuff - logrus structured logging (or zap?) |