fastify / fastify-swagger

Swagger documentation generator for Fastify
MIT License
889 stars 199 forks source link

No valid examples and migration guide does not work out of the box #785

Open baughmann opened 4 months ago

baughmann commented 4 months ago

Prerequisites

Fastify version

8.14.0

Plugin version

No response

Node.js version

20.11.0

Operating system

Linux

Operating system version (i.e. 20.04, 11.3, 10)

Ubuntu 23.10

Description

None of the example in the /examples directory are up-to-date with 8+, so none of them work. Additionally, none of the example in the migration guide feature complete minimal usable examples. There are no examples of how to use 8+.

Normally, this is some low-hanging fruit that I would be more than happy to tackle but I have yet to figure out how to get this library to produce a spec that contains my endpoints. Regardless, I'm excited to use it!

Steps to Reproduce

Copy any example in /examples or copy and paste any of the examples in the migration guide and just attempt to use them.

Expected Behavior

A functional, complete, and minimal example of how to use this library

Uzlopak commented 4 months ago

Did you read the readme.md?

Are you aware of the package @fastify/swagger-ui?