https://github.com/bterlson/typespec-todo

A todo application API specified in TypeSpec
https://github.com/bterlson/typespec-todo

Last synced: about 1 month ago
JSON representation

A todo application API specified in TypeSpec

• Host: GitHub
• URL: https://github.com/bterlson/typespec-todo
• Owner: bterlson
• Created: 2024-02-16T01:49:46.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-03-13T03:11:28.000Z (6 months ago)
• Last Synced: 2024-06-11T10:23:22.491Z (3 months ago)
• Language: TypeScript
• Size: 137 KB
• Stars: 6
• Watchers: 1
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# TypeSpec Todo

A todo application written in using TypeSpec.

The server is implemented in as much of an API-first way as possible. To start the server, run:

```

> npm install

> npm run build

> npm run start

```

Interesting features:

- TypeSpec, generating JSON Schema, OpenAPI3, and clients in multiple languages.

- Docs are exposed under the `/docs` endpoint.

- TypeScript types are generated from JSON Schema using `json-schema-to-typescript`.

- Routes are attached and requests/responses are validated based on the OpenAPI using `fastify-openapi-glue`.

## Prerequisites

1. Install [node](https://nodejs.org).

2. Install [TypeSpec](https://typespec.io) `npm install -g @typespec/compiler`

3. For Python codegen, install [Python](https://python.org) and [pip](https://pip.pypa.io/en/stable/installation/).

4. For Java codegen, install the [JDK](https://www.oracle.com/java/technologies/downloads/#java17) 17 or higher.

5. For CSharp codegen, install the [.NET SDK](https://dotnet.microsoft.com/en-us/download) version 8 or higher.