Skip to content
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.

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

Add README.md for dotnet-svcutil package. #5622

Merged
merged 4 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions src/dotnet-svcutil/src/README-nuget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## About

The `dotnet-svcutil` tool is a .NET command-line utility for retrieving metadata from web services or WSDL files and generating WCF client proxy classes. It is compatible with .NET Core and .NET Standard projects, similar to the svcutil tool for .NET Framework.

## How to use

### Installing dotnet-svcutil:

To install the dotnet-svcutil tool globally, run:

`dotnet tool install --global dotnet-svcutil`

For more details, visit the NuGet package page: [dotnet-svcutil on NuGet](https://www.nuget.org/packages/dotnet-svcutil).

### Using dotnet-svcutil:

To use the dotnet-svcutil tool, execute the following command:

`dotnet-svcutil <metadataDocumentPath> | <url> | <epr> [options*]`


For additional usage instructions, refer to the [dotnet-svcutil documentation on GitHub](https://github.com/dotnet/wcf/tree/main/src/dotnet-svcutil#using-dotnet-svcutil).


## Key Features

Dotnet-svcutil can generate code for service contracts, clients and data types from metadata documents. These metadata documents can be on a durable storage, or be retrieved online. Online retrieval follows the WS-Metadata Exchange protocol.

You can use dotnet-svcutil tool to generate service and data contracts based on a predefined WSDL document. Use the `--serviceContract` switch and specify a URL or file location where the WSDL document can be downloaded or found. This generates the service and data contracts defined in the WSDL document that can then be used to implement a complaint service.

## Additional documentation

For more details about the tool usage, visit the [WCF dotnet-svcutil tool guide](https://learn.microsoft.com/en-us/dotnet/core/additional-tools/dotnet-svcutil-guide?tabs=dotnetsvcutil2x).

## Feedback & Contributing

To explore the project or contribute, visit our [GitHub repository](https://github.com/dotnet/wcf/tree/main/src/dotnet-svcutil).
For reporting issues or providing feedback, please [open an issue on GitHub](https://github.com/dotnet/wcf).
2 changes: 2 additions & 0 deletions src/dotnet-svcutil/src/dotnet-svcutil.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<GenerateAssemblyInformationalVersionAttribute>false</GenerateAssemblyInformationalVersionAttribute>
<NoDefaultExcludes>true</NoDefaultExcludes>
<EnableXlfLocalization>true</EnableXlfLocalization>
<PackageReadmeFile>README-nuget.md</PackageReadmeFile>
</PropertyGroup>

<PropertyGroup>
Expand Down Expand Up @@ -45,5 +46,6 @@

<ItemGroup>
<ProjectReference Include="..\lib\src\dotnet-svcutil-lib.csproj" />
<None Include="README-nuget.md" Pack="true" PackagePath="\"/>
</ItemGroup>
</Project>
Loading