demo

Overview ¶

Package demo API

Demonstrates type alias handling with the --transparent-aliases flag.

This example shows how type aliases (e.g., type UserID = Identifier) are handled differently:

Without --transparent-aliases (default post-#3227):

• UserID appears as a definition in swagger.json
• User.id references #/definitions/UserID

With --transparent-aliases:

• UserID does NOT appear in definitions
• User.id references #/definitions/Identifier directly
• Matches pre-#3227 behavior

To see the difference:

  swagger generate spec -m -o without-flag.json
  swagger generate spec -m --transparent-aliases -o with-flag.json
  diff <(jq . without-flag.json) <(jq . with-flag.json)

	Schemes: https
	Host: localhost
	Version: 1.0.0

	Consumes:
	- application/json

	Produces:
	- application/json

swagger:meta