Skip to content

Commit 83b730b

Browse files
author
Chris Wiechmann
committed
Merge branch 'google-maps' of https://github.com/Axway-API-Builder-Ext/api-builder-extras into google-maps
2 parents 7005355 + d5aa441 commit 83b730b

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

api-builder-plugin-fn-google-maps/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# API-Builder Google-Maps Connector
44

5-
Integrate Google-Maps services into your [API-Builder flow][1] using this connector.
5+
Integrate Google-Maps services into your [API-Builder flow][1] using this connector. Google-Maps Services are a number of APIs provided by Google and this connector helps you to integrate with them easily.
66

77
## Configuration
88

@@ -15,14 +15,20 @@ During installation a new config file has been automatically created which must
1515
We recommend to setup your configuration in a [environmentalized][4] way keeping [sensitive information][5] away from the source-code repository.
1616

1717
## Google-Maps services
18-
This Connector is based on the https://github.com/googlemaps/google-maps-services-js and it's a good starting point to understand the APIs and each parameter.
18+
This Connector is based on the https://github.com/googlemaps/google-maps-services-js project. It's a good starting point to understand the APIs and their parameters reading the following documentation:
1919

2020
- [Directions API](https://developers.google.com/maps/documentation/directions/start)
2121
- [Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/start)
2222
- [Elevation API](https://developers.google.com/maps/documentation/elevation/)
2323
- [Geocoding API](https://developers.google.com/maps/documentation/geocoding/)
2424
- [Places API](https://developers.google.com/places/web-service/)
2525

26+
## Tests
27+
The connector is shipped with a number of Unit- and Integration tests. To execute the test-suite locally, please setup an environment variable:
28+
`GOOGLE_API_KEY=AIzaSyC...........Ws`
29+
And run the following command:
30+
`npm test`
31+
The tests are also automatically executed on every commit to this project.
2632

2733
## Compatibility
2834
Tested with Google-Maps Q1/2020
@@ -63,3 +69,4 @@ Please read [Contributing.md](https://github.com/Axway-API-Management-Plus/Commo
6369

6470
[img1]: imgs/google-maps-flownode.png
6571
[img2]: imgs/google-maps-directions.png
72+
[img3]: imgs/google-maps-config.png

0 commit comments

Comments
 (0)