Skip to content
This repository was archived by the owner on Sep 13, 2019. It is now read-only.

Commit bb1cfc0

Browse files
committed
Update README.md
1 parent f038a1c commit bb1cfc0

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,27 @@ MSBuild executes `Postman.WebApi.MsBuildTask.Generator` as an _AfterBuild_ task
1313
* Documents `Authorize` and `Obsolete` attributes
1414
* Documents OData `EnableQuery` attribute
1515
* You can use tags like `<c>`, `<code>`, `<para>`, `<example>`, `<exception>`, `<paramref>`, `<see>`, `<seealso>`, `<typeparamref>`
16-
#### How do I use it?
16+
17+
####How do I use it?
1718
1. Install the [NuGet package](https://www.nuget.org/packages/Postman.WebApi.MsBuildTask)
1819
1. Make sure you have checked the "XML Documentation file" checkbox in the build properties for the project containing your ApiControllers
1920
1. Build your project to create the `<AssemblyName>.postman.json` file in your project root
2021
1. Open Postman and import the collection file
2122
1. Add a new Postman [environment](https://www.getpostman.com/docs/environments) and set _key_ to `url` and _value_ to your http api endpoint root e.g. `http://localhost:3000/myapp`
2223

23-
#### How do I configure it?
24+
####How do I configure it?
2425
You can override the default configuration by modifying the `.targets` file located in the `packages` directory. __Note that removing/upgrading the package will set the configuration back to the defaults.__
26+
2527
| Option | Description | Default | Required |
2628
| ------ | ----------- | ------- | -------- |
2729
| `OutputDirectory` | The directory to write the output Postman .json file | `$(ProjectDir)` | Yes
2830
| `AssemblyFilePath` | The complete path and file name to the project target assembly | `$(TargetPath)` | Yes
2931
| `EnvironmentKey` | The Postman [environment](https://www.getpostman.com/docs/environments) key variable | `url` | No
3032
| `RouteTemplate` | The HTTP route template used to setup route maps | `api/{controller}` | No
33+
3134
#### Can I contribute?
3235
Please do! PRs are welcome. Just follow the conventions in the source code.
36+
3337
#### Usage notes
3438
1. The XML documentation file must be located in the same folder as the project assembly target _and_ have the same name. For example, if your project assembly is called `myproject.dll`, the XML documentation file must be named `myproject.xml` and be located in the same directory (e.g. `bin\debug`).
3539
1. Errors, warnings and messages from the Postman build task can be viewed in the Output | Build window and the build Error List

0 commit comments

Comments
 (0)