fastify-swagger icon indicating copy to clipboard operation
fastify-swagger copied to clipboard

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

Open baughmann opened this issue 1 year ago • 1 comments

Prerequisites

  • [X] I have written a descriptive issue title
  • [X] I have searched existing issues to ensure the bug has not already been reported

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

baughmann avatar Feb 23 '24 01:02 baughmann

Did you read the readme.md?

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

Uzlopak avatar Feb 23 '24 02:02 Uzlopak