https://github.com/ootkin/skimx

Create web applications using OpenAPI schemas
https://github.com/ootkin/skimx

express generator javascript oas openapi schema skimx specification typescript zod zod-openapi

Last synced: 3 months ago
JSON representation

Create web applications using OpenAPI schemas

• Host: GitHub
• URL: https://github.com/ootkin/skimx
• Owner: ootkin
• License: mit
• Created: 2023-12-20T20:58:57.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-28T06:39:43.000Z (3 months ago)
• Last Synced: 2024-10-31T10:51:28.192Z (3 months ago)
• Topics: express, generator, javascript, oas, openapi, schema, skimx, specification, typescript, zod, zod-openapi
• Language: TypeScript
• Homepage: https://ootkin.github.io/skimx/
• Size: 918 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SkimX

SkimX streamlines web application development with OpenAPI schemas that validate and infer types, ensuring consistency between contracts and codebases.

This tool leverages both [express](https://github.com/expressjs/express) and [zod](https://github.com/colinhacks/zod) to facilitate the creation of web applications and the automatic generation of OpenAPI specifications.

## Installation

Install via npm:

```shell

npm install skimx

```

## Basic usage and documentation

For basic usage and in-depth documentation, we invite you to explore our comprehensive [documentation](https://ootkin.github.io/skimx), where you'll find detailed information on getting started and utilizing SkimX to its full potential.

## Contributing

Contributions to SkimX are welcome! Whether it's bug reports, feature requests, or code contributions, please feel free to make your input.

## License

SkimX is licensed under the MIT License.

## Support

If you have any questions or encounter issues with SkimX, please open an issue on the GitHub repository. Our team will be happy to assist you.