You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 13, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,23 +13,27 @@ MSBuild executes `Postman.WebApi.MsBuildTask.Generator` as an _AfterBuild_ task
13
13
* Documents `Authorize` and `Obsolete` attributes
14
14
* Documents OData `EnableQuery` attribute
15
15
* 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?
17
18
1. Install the [NuGet package](https://www.nuget.org/packages/Postman.WebApi.MsBuildTask)
18
19
1. Make sure you have checked the "XML Documentation file" checkbox in the build properties for the project containing your ApiControllers
19
20
1. Build your project to create the `<AssemblyName>.postman.json` file in your project root
20
21
1. Open Postman and import the collection file
21
22
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`
22
23
23
-
####How do I configure it?
24
+
####How do I configure it?
24
25
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
+
25
27
| Option | Description | Default | Required |
26
28
| ------ | ----------- | ------- | -------- |
27
29
| `OutputDirectory` | The directory to write the output Postman .json file | `$(ProjectDir)` | Yes
28
30
| `AssemblyFilePath` | The complete path and file name to the project target assembly | `$(TargetPath)` | Yes
29
31
| `EnvironmentKey` | The Postman [environment](https://www.getpostman.com/docs/environments) key variable | `url` | No
30
32
| `RouteTemplate` | The HTTP route template used to setup route maps | `api/{controller}` | No
33
+
31
34
#### Can I contribute?
32
35
Please do! PRs are welcome. Just follow the conventions in the source code.
36
+
33
37
#### Usage notes
34
38
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`).
35
39
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