Very confused about the default usage

[markedwards]

After the quick start and running @hey-api/openapi-ts -i path/to/openapi.json -o src/client, how do I use the generated code? Is there an example somewhere?

I see the examples in this repository, but they seem to have additional dependencies, etc. I just want to use the basic generated code with fetch. Is that possible?

[mrlubos]

Hey @markedwards, did you see the demo linked in docs?

[mrlubos]

It's a very similar usage for the new Fetch API client, the extra dependencies in those examples are my attempt at slowly evolving the demo into a more real-world example.

Tl;dr you only need @hey-api/openapi-ts in devDependencies and optionally @hey-api/client-fetch in dependencies if you want the latest client

[anbraten]

I was (am) pretty confused how the "client" has to be used. I think it would really had helped me if the Quick start includes a basic usage of the generated code as well. This would provide a basic start to finish for new users. If the user has a basic understanding how the generated code works its normally pretty easy to adopt more advanced ways / options. As fetch seems to be a good common usage what do you think about adding a section above Examples like:

Usage

One way of using your newly created client is by using a service function like addPet:

import { addPet } from './client/services.gen';

const { data, error } = await addPet({
  body: {
    id: 0,
    name: 'Pluto',
    status: 'available',
  },
});
if (error) {
  console.log(error);
  return;
}

More clients and ways to use the generated code can be found ...

[mrlubos]

Hey @anbraten, you have a basic usage of the generated code in StackBlitz examples. Are you asking for a step-by-step tutorial that would take you from the install command to the result you can see in StackBlitz?

[anbraten]

The StackBlitz example is great. However considering that it is quite complex I think just a super short snippet similar to the one posted above provides a nice idea to new users how it basically works. Especially in comparison to other tools that use a different syntax like:

await octokit.request("POST /repos/{owner}/{repo}/issues", {
  owner: "octocat",
  repo: "hello-world",
  title: "Hello, world!",
  body: "I created this issue using Octokit!",
});

(Any plans to support such a syntax at some point?)

[mrlubos]

Not anytime soon! Good shout on the tutorial, thank you