Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
@typespec/openapi3
Advanced tools
TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding
TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding
npm install @typespec/openapi3
tsp compile . --emit=@typespec/openapi3
emit:
- "@typespec/openapi3"
file-type
Type: "yaml" | "json"
If the content should be serialized as YAML or JSON. Default 'yaml', it not specified infer from the output-file
extension
output-file
Type: string
Name of the output file. Output file will interpolate the following values:
Default: {service-name}.{version}.openapi.yaml
or .json
if file-type
is "json"
Example Single service no versioning
openapi.yaml
Example Multiple services no versioning
openapi.Org1.Service1.yaml
openapi.Org1.Service2.yaml
Example Single service with versioning
openapi.v1.yaml
openapi.v2.yaml
Example Multiple service with versioning
openapi.Org1.Service1.v1.yaml
openapi.Org1.Service1.v2.yaml
openapi.Org1.Service2.v1.0.yaml
openapi.Org1.Service2.v1.1.yaml
new-line
Type: "crlf" | "lf"
Set the newline character for emitting files.
omit-unreachable-types
Type: boolean
Omit unreachable types. By default all types declared under the service namespace will be included. With this flag on only types references in an operation will be emitted.
include-x-typespec-name
Type: "inline-only" | "never"
If the generated openapi types should have the x-typespec-name
extension set with the name of the TypeSpec type that created it.
This extension is meant for debugging and should not be depended on.
safeint-strategy
Type: "double-int" | "int64"
How to handle safeint type. Options are:
double-int
: Will produce type: integer, format: double-int
int64
: Will produce type: integer, format: int64
Default: int64
@oneOf
Specify that oneOf
should be used instead of anyOf
for that union.
@TypeSpec.OpenAPI.oneOf
Union | ModelProperty
None
@useRef
Specify an external reference that should be used inside of emitting this type.
@TypeSpec.OpenAPI.useRef(ref: valueof string)
Model | ModelProperty
Name | Type | Description |
---|---|---|
ref | valueof string | External reference(e.g. "../../common.json#/components/schemas/Foo") |
FAQs
TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec
The npm package @typespec/openapi3 receives a total of 56,893 weekly downloads. As such, @typespec/openapi3 popularity was classified as popular.
We found that @typespec/openapi3 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.