microsoft / microsoft/typespec

Installation instructions for adding TypeSpec to existing projects

Open
#7,712 3 comments 0 reactions 0 assignees View on GitHub
docs feature needs-area triaged:core
Dominant language
Java
Stars
5.9k
Forks
394
Avg merge
1d 23h
Merged PRs (30d)
104

Description

Hello! I came across TypeSpec while looking for a way to document my application's API and it looks great. However, the installation instructions only point me toward using `tsp init`, which will overwrite a lot of files in an existing project. It seems like `tsp init` is meant for projects where the API documentation is meant to be a reference for many different teams and thus to stand apart from any actual implementation code.

In my case, I plan to use TypeSpec as a way to document my API and nicely emit an OpenAPI schema. I'd love to see some installation instructions for adding TypeSpec to a project where the .tsp files will sit alongside existing code.

Thanks!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.