libscie/researchequals-api
1
0
Fork 0
Code Issues 18 Pull requests Projects Releases Packages Activity

Implement OpenAPI compliance #1

New issue
Open
opened 2025-07-18 11:46:02 +00:00 by chartgerink · 2 comments
chartgerink commented 2025-07-18 11:46:02 +00:00
Owner
Copy link

We want to make our own lives easier and others' as well. Being OpenAPI compliant means we can generate machine readable information about our API, which has downstream benefits. This includes generating API documentation pages (for example, with Swagger) and potentially even whole Software Development Kits (SDKs), I am learning now.

The benefits need to be better researched, but even if it is only the documentation website/pages that can be generated it is already worth a lot! This issue tracks the work and is a place to share resources.

https://openapi.tools

https://buildwithfern.com/
https://www.speakeasy.com/

We want to make our own lives easier and others' as well. Being OpenAPI compliant means we can generate machine readable information about our API, which has downstream benefits. This includes generating API documentation pages (for example, with Swagger) and potentially even whole Software Development Kits (SDKs), I am learning now. The benefits need to be better researched, but even if it is only the documentation website/pages that can be generated it is already worth a lot! This issue tracks the work and is a place to share resources. https://openapi.tools https://buildwithfern.com/ https://www.speakeasy.com/
chartgerink commented 2025-07-22 12:58:04 +00:00
Author
Owner
Copy link

It seems like the best choice to do this is with the crate utoipa 👍

It seems like the best choice to do this is with the crate [`utoipa`](https://github.com/juhaku/utoipa) 👍
chartgerink commented 2025-08-01 08:40:44 +00:00
Author
Owner
Copy link

See also #10 for an outdated trial that seemed decent.

See also #10 for an outdated trial that seemed decent.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels   
bug

Something is not working

  
critical

issues that are blocking other work, high importance + urgent

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
future

Not on the docket right now. Keeping the issue for future work.

  
help wanted

Need some help

  
invalid

Something is wrong

  
question

More information is needed

  
wontfix

This won't be fixed

No labels
bug
critical
duplicate
enhancement
future
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: libscie/researchequals-api#1
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?