IBCornelsen/online-energieausweis
1
0
Fork 0
Code Issues 272 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

tRPC + OpenAPI für unsere API #582

New Issue
Open
opened 2025-10-18 16:57:30 +00:00 by Letsmoe · 0 comments
Letsmoe commented 2025-10-18 16:57:30 +00:00 (Migrated from github.com)
Copy Link

Um komplette Type Safety zu gewährleisten und vor allem, damit wir uns selber noch dran erinnern können was wir an unsere API schicken und was wir zurückbekommen habe ich nun auch noch tRPC hinzugefügt. Hier ist deren Dokumentation, falls ihr euch die mal anschauen möchtet.

https://trpc.io/docs

Dazu habe ich noch tRPC-OpenApi reingenommen, damit wir unsere API öffentlich zugänglich machen können: https://github.com/jlalmes/trpc-openapi

Im Code findet ihr die api immer noch im /src/api Ordner, die API ist in verschiedene Versionen aufgeteilt, falls wir in Zukunft Updates reinbringen müssen, die die Struktur grob verändern.

Um z.B. einen Verbrauchsausweis Wohngebäude mit dem EnEV Schema 2016 in der ersten API Version zu erstellen würde man so einen Link benutzen:

https://online-energieausweis.org/api/v1/verbrauchsausweis-wohnen/2016/erstellen

Migrated from Trello Card

Um komplette Type Safety zu gewährleisten und vor allem, damit wir uns selber noch dran erinnern können was wir an unsere API schicken und was wir zurückbekommen habe ich nun auch noch tRPC hinzugefügt. Hier ist deren Dokumentation, falls ihr euch die mal anschauen möchtet. [https://trpc.io/docs](https://trpc.io/docs "smartCard-inline") Dazu habe ich noch tRPC-OpenApi reingenommen, damit wir unsere API öffentlich zugänglich machen können: [https://github.com/jlalmes/trpc-openapi](https://github.com/jlalmes/trpc-openapi "smartCard-inline") Im Code findet ihr die api immer noch im /src/api Ordner, die API ist in verschiedene Versionen aufgeteilt, falls wir in Zukunft Updates reinbringen müssen, die die Struktur grob verändern. Um z.B. einen Verbrauchsausweis Wohngebäude mit dem EnEV Schema 2016 in der ersten API Version zu erstellen würde man so einen Link benutzen: [https://online-energieausweis.org/api/v1/verbrauchsausweis-wohnen/2016/erstellen](https://online-energieausweis.org/api/v1/verbrauchsausweis-wohnen/2016/erstellen "‌") --- > Migrated from [Trello Card](https://trello.com/c/pwn4PIad/13-trpc-openapi-f%C3%BCr-unsere-api)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
Kind/Bug
Something isn't working
Kind/Documentation
Improvements or additions to documentation
Kind/Enhancement
New feature or request
Kind/Feature
New functionality
Kind/Security
This is a security issue
Kind/Testing
Issue or pull request related to testing
Priority/Critical
The priority is critical
Priority/High
The priority is high
Priority/Low
The priority is low
Priority/Medium
The priority is medium
Reviewed/Confirmed
Issue has been confirmed
Reviewed/Duplicate
This issue or pull request already exists
Reviewed/Invalid
Invalid issue
Reviewed/Won't Fix
This will not be worked on
Status/Abandoned
Somebody has started to work on this but abandoned work
Status/Backlog
Item was backlogged and will not be worked on right now.
Status/Blocked
Something is blocking this issue or pull request
Status/Need More Info
Feedback is required to reproduce issue or to continue work
No Label
Kind/Documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
moritz
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: IBCornelsen/online-energieausweis#582
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?