swagger-api / swagger-api/swagger-codegen

[Typescript] [Question] example of how to use typescript-angular-client codegen?

Open
#8,068 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

As addressed in this old thread: https://github.com/swagger-api/swagger-codegen/issues/3221 I would like to see how you actually use it with a basic example, not just linking another project where it has been done as this is no help at all or explanation of what has been done..

How do I get to view the pet.service.ts pet.ts etc in swagger? I have ran the other example of creating "hello world" with swagger project create, but this is in a .js which again is no help but it works within the swagger editor which was cool...

So may I please get a clear explanation of what do I do with these files as it has not been addressed anywhere I have checked online. Is there more to the set-up? I can't run swagger start typescript-angular-client so do I need more dependencies?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the requested typescript-angular-client flow and the generated pet.service.ts and pet.ts files, then compare it with the existing Swagger Editor hello-world example. Document how to generate, view, set up, and use these files, including whether additional dependencies are required. Done means a basic example clearly explains the setup and usage without relying only on an external project.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.