1.0.0-alpha.1 • Published 8 months ago
swapi-typespec v1.0.0-alpha.1
SWAPI TypeSpec
TypeSpec representation of SWAPI: The Star Wars API.
About
I created this project to learn about TypeSpec through first-hand usage.
The generated Open API 3 specification has 878 lines (with no blank lines) in a single file. The TypeSpec source has 493 lines (about ⅓ are blank lines for readability) split across 8 files for logical organization, which is a ~45% reduction in lines of code.
If we ignore the imports, using statements, and blank lines within models, then the TypeSpec only has 353 lines. That means a 60% reduction in code to maintain.
Getting started
Follow these steps to consume the generated Open API specification for SWAPI.
Install this package as a dependency.
npm install -D swapi-typespec
Reference the generated Open API specification directly.
./node_modules/swapi-typespec/swapi.openapi.yaml
1.0.0-alpha.1
8 months ago
1.0.0-alpha.0
8 months ago