PieFed API & mobile app dev

90 readers

1 users here now

Announcements and discussions about the PieFed API - changes, improvements and general co-ordination between the frontend developers and the core of PieFed.

founded 1 month ago

MODERATORS

rimu@piefed.social

PieFed OpenAPI docs - swagger (freamon.github.io)

submitted 1 month ago by rimu@piefed.social to c/piefed_api@piefed.social

9 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[–] rimu@piefed.social 1 points 4 weeks ago (1 children)

Since your comment we've been looking into what it would take to auto-generate the swagger docs. The package we're thinking about using produces OpenAPI v2 json but I understand there is now OpenAPI v3 that people have been using for a while. Do you have a need for v3 or would v2 be ok?

[–] sjmarf@lemmy.ml 1 points 4 weeks ago* (last edited 4 weeks ago)

Thanks for looking into it :)

I don’t have a need for v3, but I’d caution that you might do - v2 is missing quite a few features compared to v3. For example, Swagger v2 doesn’t support oneOf, allOf and anyOf. I believe you’re using some of those in the docs currently? I’d check but I’m not near a computer right now. I’m happy using v2 if you’re happy with it.

Edit: oops, typed some of the versions numbers the wrong way around. Apologies for any confusion