ApiExplr 1.0.4

There is a newer version of this package available.
See the version list below for details.

dotnet add package ApiExplr --version 1.0.4

NuGet\Install-Package ApiExplr -Version 1.0.4

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="ApiExplr" Version="1.0.4">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ApiExplr" Version="1.0.4" />
                    

                            Directory.Packages.props

<PackageReference Include="ApiExplr">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add ApiExplr --version 1.0.4

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ApiExplr, 1.0.4"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package ApiExplr@1.0.4

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=ApiExplr&version=1.0.4
                    

                            Install as a Cake Addin

#tool nuget:?package=ApiExplr&version=1.0.4
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

A simple test client for your web api 2 application.

At work we run various web api applications. RESTful services. Lots of uri’s. Lots of contracts. Lots of client application.

To help share the knowledge of what these services do, I’ve created a web api explorer client using reflection.

This is a friendly and informative alternative to using Fiddle, Simple JS Client, the standard .Net Help page, and similar other adhoc testing / documentation tools.

Try it out. Send me some feedback.

Product	Compatible and additional computed target framework versions.
.NET Framework	net is compatible.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.10	3,469	8/11/2014
1.0.9	2,432	8/10/2014
1.0.7	2,342	8/9/2014
1.0.6	2,456	8/9/2014
1.0.5	2,298	8/9/2014
1.0.4	2,327	8/9/2014
1.0.3	2,404	8/3/2014
1.0.2	2,291	8/3/2014
1.0.1	2,285	8/3/2014
1.0.0	2,335	8/3/2014

Getting started with this Nuget package, from scratch.

1. Create a new web api 2 project in Visual Studio.
2. Add the 'ApiExplr' Nuget package.
3. Switch on Documentation for your web api application. Project > Properties > Build > Xml documentation file > "\App_Data\XmlDocument.xml".

That's it! You're done :)

Fire up your new ApiExplr app at http://location:[port]/areas/apiexplr

## Configuration

FeedUri: http://localhost:[port]/api/explr
BaseRequestUri: http://localhost:[port]

## Comments and Info

Add ///comments to every controller and action. It's these comments that end up in your XmlDocumentation file and get resolved.

## Attribute Routing

This project relies on Attribute Routing. Remove "config.Routes.MapHttpRoute" from WebApiConfig.cs.

Every controller must have a [RoutePrefix]. Every action must have a [Route] and a Http Action Verb [HttpGet].