Skip to content

📝 Reference swapi.info #7

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 15, 2025
Merged

📝 Reference swapi.info #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# SWAPI TypeSpec

[TypeSpec][typespec] representation of [SWAPI: The Star Wars API][swapi].
[TypeSpec][typespec] representation of SWAPI: The Star Wars API.

[swapi]: https://swapi.dev
🎉 Shout out to [swapi.info][swapi] for hosting a stable version of the API. 🎉

[swapi]: https://swapi.info
[typespec]: https://microsoft.github.io/typespec/

<!-- Badges: Use link shorthand for readability and easier reordering -->
Expand All @@ -21,13 +23,12 @@

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.
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.
This 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.
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.

## Installation

Expand Down
4 changes: 2 additions & 2 deletions src/main.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ using Versioning;

/** SWAPI: The Star Wars API (generated with TypeSpec from [swapi-typespec](https://github.com/connorjs/swapi-typespec#readme)). */
@service(#{ title: "SWAPI (TypeSpec)" })
@server("https://swapi.dev/api/", "SWAPI server")
@externalDocs("https://swapi.dev/")
@server("https://swapi.info/api/", "SWAPI server")
@externalDocs("https://swapi.info/")
@versioned(Version)
namespace SWAPI;

Expand Down