Usage as a library about restish HOT 4 CLOSED

Thanks a lot for the ideas! Looks good for me to go explore things, will get back if something more could be done! 😄

from restish.

It's possible to add your own custom formats, auth, commands, etc to Restish pretty easily, for example the main.go setup just looks like this:

cli.Init("restish", version)

// Register default encodings, content type handlers, and link parsers.
cli.Defaults()

// Register format loaders to auto-discover API descriptions
cli.AddLoader(openapi.New())

// Register auth schemes
cli.AddAuth("oauth-client-credentials", &oauth.ClientCredentialsHandler{})
cli.AddAuth("oauth-authorization-code", &oauth.AuthorizationCodeHandler{})

// Run the CLI, parsing arguments, making requests, and printing responses.
cli.Run()

You can do a cli.Root.AddCommand(&cobra.Command{......}) before calling cli.Run().

If you prefer to just get a bunch of pre-configured commands and inject those into your CLI, I haven't tried that but you might be able to. There is a cli.Load(entrypoint string, root *cobra.Command) you can try to use. You'll still need to cli.AddLoader(openapi.New()) if you want it to recognize OpenAPI.

Any improvements to make this easier or better are welcome! 👍

Edit: I'm also contemplating whether it would be worth supporting some kind of plugin or scripting functionality to enable custom commands. 🤔

from restish.

Thanks a lot for the pointers, will try them out soon! 😄 As for the extensibility aspects, it would be great, at least for me, if I can just hook in my commands which aren't necessarily talking to the API. Also maybe a way to customise the handler of the OperationId, the way i was thinking before I found restish is taking a map like:

map[string]func(params map[string]any) error{
  "opid1": func(params map[string]any) error {
    // some potential side-effects
    return err
  },
  ...
}

and passing it along to the init or something? I think having something like this enables more custom behaviour while still keeping the underlying things same?

from restish.

As for the extensibility aspects, it would be great, at least for me, if I can just hook in my commands which aren't necessarily talking to the API.

Using cli.Root.AddCommand(&cobra.Command{......}) lets you add any custom command you want, for example:

cli.Init("my-cli", "1.0.0")

cli.Root.AddCommand(&cobra.Command{
	Use:  "hello",
	Args: cobra.ExactArgs(1),
	Run: func(cmd *cobra.Command, args []string) {
		// You can do anything you want here, no need to talk to any API!
		fmt.Printf("Hello, %s!\n", args[0])
	},
})

cli.Run()

Then you can try it out:

$ go run . hello lispyclouds
Hello lispyclouds!

from restish.