Skip to content

Commit

Permalink
updated to reflect mocktarget.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
llynch00 committed Jun 3, 2016
1 parent 38f8312 commit c3b196b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions default-proxies/helloworld/openapi/readme.md
@@ -1,8 +1,8 @@
# OpenAPI spec for the helloworld sample

`helloworld.yaml` is an [OpenAPI specification](https://openapis.org/) for Apigee's `helloworld` RESTful target service, located at http://mocktarget.apigee.net (more information about the service [here](https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld)).
`mocktarget.yaml` is an [OpenAPI specification](https://openapis.org/) for Apigee's mock RESTful target service, located at http://mocktarget.apigee.net (more information about the service [here](https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld)).

With `helloworld.yaml`, you can generate interactive SmartDocs API documentation for the helloworld service in your Edge developer portal just like you would any OpenAPI spec you created yourself. In fact, we used `helloworld.yaml` to generate SmartDocs on the [Apigee documentation site](http://docs.apigee.com/api-services/content/hello-world-sample-proxy-api) for you to try out.
With `mocktarget`, you can generate interactive SmartDocs API documentation for the mock target service in your Edge developer portal just like you would any OpenAPI spec you created yourself. In fact, we used `mocktarget.yaml` to generate SmartDocs on the [Apigee documentation site](http://docs.apigee.com/api-services/content/mock-target-api) for you to try out.

For more information on how to generate SmartDocs with an OpenAPI spec, see [Using SmartDocs to document APIs](http://docs.apigee.com/developer-services/content/using-smartdocs-document-apis) in the Apigee docs.

Expand Down

0 comments on commit c3b196b

Please sign in to comment.