Postman

Demis Bellot edited this page Oct 25, 2016 · 6 revisions

This page has moved to docs.servicestack.net/postman


The Postman Rest Client is a very popular and easy to use HTTP Request composer that makes it easy to call web services, similar to Fiddler's Composer. It also provides as an alternative for autogenerating API documentation to ServiceStack's Swagger support that makes it easier to call existing services but does require users to install the Postman Rest Client.

Support for Postman is built into ServiceStack and can be enabled by registering the Plugins below:

Plugins.Add(new PostmanFeature());
Plugins.Add(new CorsFeature());

Note: As Postman makes cross-site requests, is also requires CORS support.

Once enabled, a link with appear in your metadata page:

Postman Metadata link

Importing the Postman Collection

By default the link to the Postman JSON metadata collection is at /postman, this url can be imported into postman by clicking on import collections:

Postman Import Icon

This will open up the import dialog, where you can paste the metadata url and click Import:

Postman Import Dialog

Available Routes

Once imported it will populate a list of available operations that can be selected and easily called from within the Postman UI. Just like the Swagger Support the list of operations returned respects the Restriction Attributes and only shows the operations each user is allowed to see. The operations returned also favour custom user-defined routes, when none exists it will fallback to use the pre-defined routes.

Label Customization

The label for each operation can be further customized using the ?label query string param whose preferred style which can vary depending on the granularity and naming of your Request DTO's, and whether they have custom routes defined on them.

Postman Label Styles

The screenshot above shows an example of importing the same service with the different label styles below:

The label param accepts a collection of string tokens that controls how the label is formatted.The type and route are special tokens that get replaced by the Request DTO name and Route respectively. Everything else are just added string literals including the + character which is just a url-encoded version of the space character.

Here are some examples using the example definition below:

[Route("/contacts/{Id}")]
public class GetContact { ... }
/postman?label=type GetContact
/postman?label=route /contacts/{Id}
/postman?label=type:english Get contact
/postman?label=type:english,+(,route,) Get contact (/contacts/{Id})

Specifying the Default Label Format

The default label format can also be configured when registering the Postman plugin, e.g:

Plugins.Add(new PostmanFeature { 
    DefaultLabelFmt = new List<string> { "type:english", " ", "route" }
});

Calling Services

Calling Services is as easy as selecting the service you want to call, filling in the parameters you want to call it with then clicking Send. At a mimimum you want to specify values for all the path variables in the /pathInfo which are prefixed with a colon followed by its name, e.g: :VariableName

Call Service in Postman

The Path Info variables appear first in the list of available URL params for each service, as seen with TestPlanId above. By default each variable is seeded with its type. Any variables defined on the /pathinfo are sent on the pathinfo whilst other variables in a GET request are sent on the Query String. POST requests also allow sending parameters as form-data.

Support for authenticated requests

Calling authentication-only services can be done with the /postman?exportSession=true parameter which will redirect to a url that captures your session cookies into a deep-linkable url like /postman?ssopt=temp&ssid={key}&sspid={key} that can be copied into Postman.

This lets you replace your session cookies with the session ids on the url, effectively allowing you to take over someone elses session, in this case telling Postman to make requests on your behalf using your authenticated session cookies.

As this functionality is potentially dangerous it's only enabled by default in DebugMode but can be overridden with:

Plugins.Add(new PostmanFeature { 
    EnableSessionExport = true
});

Other PostmanFeature options

Like other ServiceStack plugins the available options for each Feature can be configured on the Plugin itself at registration:

Registering at a custom path

Use AtRestPath to host the postman metadata route on an alternate:

Plugins.Add(new PostmanFeature { 
    AtRestPath = "/alt-postman-link"  //default /postman
});

Sending Custom HTTP Headers

Use Headers to get Postman to send custom HTTP Headers on each request, e.g:

Plugins.Add(new PostmanFeature { 
    Headers = "Accept: application/json\nX-Custom-Header: Value",
});

The default is Accept: application/json to ensure each request returns its response as JSON. Multiple headers can be separated with the \n new-line character.

Friendly Type Aliases

The names of the type for Request DTO Property Types displayed can also be customized by adding them to the FriendlyTypeNames Dictionary. E.g. we can show DateTime types as Date in Postmans UI with:

Plugins.Add(new PostmanFeature { 
    FriendlyTypeNames = { {"DateTime", "Date"} },
});


  1. Getting Started

    1. Creating your first project
    2. Create Service from scratch
    3. Your first webservice explained
    4. Example Projects Overview
    5. Learning Resources
  2. Designing APIs

    1. ServiceStack API Design
    2. Designing a REST-ful service with ServiceStack
    3. Simple Customer REST Example
    4. How to design a Message-Based API
    5. Software complexity and role of DTOs
  3. Reference

    1. Order of Operations
    2. The IoC container
    3. Configuration and AppSettings
    4. Metadata page
    5. Rest, SOAP & default endpoints
    6. SOAP support
    7. Routing
    8. Service return types
    9. Customize HTTP Responses
    10. Customize JSON Responses
    11. Plugins
    12. Validation
    13. Error Handling
    14. Security
    15. Debugging
    16. JavaScript Client Library (ss-utils.js)
  4. Clients

    1. Overview
    2. C#/.NET client
      1. .NET Core Clients
    3. Add ServiceStack Reference
      1. C# Add Reference
      2. F# Add Reference
      3. VB.NET Add Reference
      4. Swift Add Reference
      5. Java Add Reference
    4. Silverlight client
    5. JavaScript client
      1. Add TypeScript Reference
    6. Dart Client
    7. MQ Clients
  5. Formats

    1. Overview
    2. JSON/JSV and XML
    3. HTML5 Report Format
    4. CSV Format
    5. MessagePack Format
    6. ProtoBuf Format
  6. View Engines 4. Razor & Markdown Razor

    1. Markdown Razor
  7. Hosts

    1. IIS
    2. Self-hosting
    3. Messaging
    4. Mono
  8. Security

    1. Authentication
    2. Sessions
    3. Restricting Services
    4. Encrypted Messaging
  9. Advanced

    1. Configuration options
    2. Access HTTP specific features in services
    3. Logging
    4. Serialization/deserialization
    5. Request/response filters
    6. Filter attributes
    7. Concurrency Model
    8. Built-in profiling
    9. Form Hijacking Prevention
    10. Auto-Mapping
    11. HTTP Utils
    12. Dump Utils
    13. Virtual File System
    14. Config API
    15. Physical Project Structure
    16. Modularizing Services
    17. MVC Integration
    18. ServiceStack Integration
    19. Embedded Native Desktop Apps
    20. Auto Batched Requests
    21. Versioning
    22. Multitenancy
  10. Caching

  11. Caching Providers

  12. HTTP Caching

  13. CacheResponse Attribute

  14. Cache Aware Clients

  15. Auto Query

  16. Overview

  17. Why Not OData

  18. AutoQuery RDBMS

  19. AutoQuery Data

  20. AutoQuery Memory

  21. AutoQuery Service

  22. AutoQuery DynamoDB

  23. Server Events

    1. Overview
    2. JavaScript Client
    3. C# Server Events Client
    4. Redis Server Events
  24. Service Gateway

    1. Overview
    2. Service Discovery
  25. Encrypted Messaging

    1. Overview
    2. Encrypted Client
  26. Plugins

    1. Auto Query
    2. Server Sent Events
    3. Swagger API
    4. Postman
    5. Request logger
    6. Sitemaps
    7. Cancellable Requests
    8. CorsFeature
  27. Tests

    1. Testing
    2. HowTo write unit/integration tests
  28. ServiceStackVS

    1. Install ServiceStackVS
    2. Add ServiceStack Reference
    3. TypeScript React Template
    4. React, Redux Chat App
    5. AngularJS App Template
    6. React Desktop Apps
  29. Other Languages

    1. FSharp
      1. Add ServiceStack Reference
    2. VB.NET
      1. Add ServiceStack Reference
    3. Swift
    4. Swift Add Reference
    5. Java
      1. Add ServiceStack Reference
      2. Android Studio & IntelliJ
      3. Eclipse
  30. Amazon Web Services

  31. ServiceStack.Aws

  32. PocoDynamo

  33. AWS Live Demos

  34. Getting Started with AWS

  35. Deployment

    1. Deploy Multiple Sites to single AWS Instance
      1. Simple Deployments to AWS with WebDeploy
    2. Advanced Deployments with OctopusDeploy
  36. Install 3rd Party Products

    1. Redis on Windows
    2. RabbitMQ on Windows
  37. Use Cases

    1. Single Page Apps
    2. HTML, CSS and JS Minifiers
    3. Azure
    4. Connecting to Azure Redis via SSL
    5. Logging
    6. Bundling and Minification
    7. NHibernate
  38. Performance

    1. Real world performance
  39. Other Products

    1. ServiceStack.Redis
    2. ServiceStack.OrmLite
    3. ServiceStack.Text
  40. Future

    1. Roadmap
Clone this wiki locally
You can’t perform that action at this time.
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.
Press h to open a hovercard with more details.