Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New library @nestia/editor #445

Closed
samchon opened this issue Jul 5, 2023 · 0 comments
Closed

New library @nestia/editor #445

samchon opened this issue Jul 5, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest

Comments

@samchon
Copy link
Owner

samchon commented Jul 5, 2023

After publishing @nestia/migrate (#292), create a new library @nestia/swagger-ui.

The new project @nestia/editor would be almost same with swagger-ui, but those things would be different.

  1. TypeScript Editor
  2. Build SDK
  3. Mockup Simulator
  4. NestJS Project Generator

1. TypeScript Editor

At first, input components of each route would be replaced to TypeScript editor.

Through the TypeScript editor, users can write input data much safely and conveniently through type checking with type hints. If you're wondering how the TypeScript editor would work on web browser, it would better to see typia playground website.

2. Build SDK

When click "Build SDK" button in @nestia/editor, SDK library would be downloaded as a zip file.

In actually, the SDK library would be composed at the entry level when swagger.json file be inserted. The initial SDK libray composition makes 1. TypeScript Editor possible. When clicking "Build SDK" button, it will download just pre-composed SDK library with zip file compression.

image

3. Mockup Simulator

When you download SDK library from @nestia/editor, it will also contain the mock-up simulator.

If you're wonder whethering what mock-up simulator is, read below article please.

4. NestJS Project Generator

When clicking "NestJS Project Generator" button, @nestia/editor will generate a NestJS project which has same API specs with the input swagger.json file. The newly generated NestJS project also have those things. If you've read #292 issue, yes, it's totally same feature with @nestia/migrate.

  • SDK library
  • Mockup Simulator
  • Automatically composed e2e test functions
@samchon samchon added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 5, 2023
@samchon samchon self-assigned this Jul 5, 2023
@samchon samchon changed the title New library @nestia/swagger-ui New library @nestia/editor Jul 5, 2023
samchon added a commit that referenced this issue Feb 17, 2024
Close #445 - TypeScript Swagger Editor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest
Projects
None yet
Development

No branches or pull requests

1 participant