Giter Site home page Giter Site logo

Better support for offline about huma HOT 3 CLOSED

danielgtaylor avatar danielgtaylor commented on August 25, 2024
Better support for offline

from huma.

Comments (3)

jonathanyuechun avatar jonathanyuechun commented on August 25, 2024 1

yes i think it does. gonna try it asap. i will let you know

from huma.

danielgtaylor avatar danielgtaylor commented on August 25, 2024

@jonathanyuechun there is an example that shows how to output the OpenAPI file at https://github.com/danielgtaylor/huma/blob/main/examples/spec-cmd/main.go#L68-L76. You can do something similar for the individual schemas if needed. For example, if I modify the command like this:

// Add a command to print the OpenAPI spec.
cli.Root().AddCommand(&cobra.Command{
	Use:   "openapi",
	Short: "Print the OpenAPI spec",
	Run: func(cmd *cobra.Command, args []string) {
		b, _ := yaml.Marshal(api.OpenAPI())
		fmt.Println(string(b))

		// Also print the individual schemas.
		for name, schema := range api.OpenAPI().Components.Schemas.Map() {
			fmt.Printf("Schema: %s\n", name)
			b, _ := yaml.Marshal(schema)
			fmt.Println(string(b))
		}
	},
})

I can then run go run ./examples/spec-cmd openapi and get output for the OpenAPI yaml and each individual JSON Schema as well. I'll leave it as an exercise to the reader to write them out into files 😄

Does that work for your use case?

from huma.

danielgtaylor avatar danielgtaylor commented on August 25, 2024

Closing as I think this is solved, but feel free to re-open if needed!

from huma.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.