Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pregress authored Oct 3, 2024
1 parent 5c06ca6 commit 4a3cacb
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,30 @@ Currenlty only removes [links](https://swagger.io/docs/specification/v3_0/links/


# Install

## Global
```
dotnet tool install -g apimsanitizer
```

## In project
```
dotnet tool install dotnet-apimsanitizer --create-manifest-if-needed
```

# Usage

## CLI
```
apimsanitizer -f ./your/path/to/api-definition.yml
```

## PreBuild target in csproj
```(xml)
<Target Name="GenerateApimFile" BeforeTargets="Build">
<Exec Command="dotnet apimsanitizer -f $(ProjectDir)/wwwroot/openapi.yml" />
</Target>
```

## Local testing

Expand All @@ -24,4 +39,4 @@ dotnet pack --configuration Release
dotnet tool install -g --add-source .\bin\Release apimsanitizer
apimsanitizer -f {path-to-openapi.yml}
```
```

0 comments on commit 4a3cacb

Please sign in to comment.