• Home
  • About

GIScience News Blog

News of Heidelberg University’s GIScience Research Group.

Feed on
Posts
Comments
« GIScience/HeiGIT and TdLab Geographie at german IPCC conference
Empower Humanitarian Mapping with Deep Neural Networks to Detect Human Settlements »

New features in OpenRouteService Interactive documentation

Mar 6th, 2019 by Amon Santana

The ORS Playground is an interactive API documentation application that allows the users to explore and interact with all the API services. The elements, inputs and forms are built from a swagger documentation file. Since the first release of the new OpenRouteService API Playground in November we have being worked on it to make some important improvements. A good part of the changes may not be easily noticed and some other are engineering changes that will easy the maintenance and the evolution of the application. But there are also important features that boost the user interaction with the API.

Assisted object fillling

Assisted object fillling

What is new?

  • Assisted JSON object filling
  • Validation and auto-focus on invalid input and auto tab switch
  • Limitless nested properties support
  • Support map for POIs and MapSurfer endpoints
  • Added support for path parameters
  • Listing body parameters at form root level and JSON body preview
  • Improved abstractions regarding doc parsing and extracting data from response
  • Compatible with API/Core v5
  • Added support for parameters dependencies

New features

Assisted object filling:

One of the most important features added was the assisted object filling. As the the API requires some parameters with nested objects, initially the user should compose a string representing the JSON object expected by the API. Now, the application identifies this case and offers and assisted filling, open a modal to guide the user through the sub properties filling based also on the API definitions, showing possible values and types. The users still have the option to paste directly a JSON string.

Validation and auto-focus on invalid input/tab:

When a user tries to submit the form the application will indicate if there are invalid fields and will also check this across tabs (body, path, URI and header parameters tabs). If an invalid field is found, the application will auto switch to the tab containing the invalid field, and focus on it. It is important to highlight that the validation and auto switch is done also based on the attributes specified in documentation.

Dependencies:

The second most important feature: this allows dependencies between parameters to be declared on the swagger documentation. Once this is specified in the documentation, the parser will take it into account and will display parameter fields conditionally, based on the value of other declared parameter field. This allows the application to present the form progressively. According the changes made by the user the fields can be shown/hidden. The fields not available are listed in bottom section with a programmatic generated explanation why it is disabled.

Parameter dependencies support

Parameter dependencies support

Limitless nested properties:

Improving the Assisted object filling, this feature has extended the initial behaviour, adding the capability of provide assisted object filling for nested para properties recursively.

Added support for new endpoints:

Added support for POIs endpoint, that returns points of interest in the area surrounding a geometry and for MapSurfer endpoint, that provides map tiles in PNG format. To be able to support MapSurfer we had to add the support for path parameters, that change the URL path instead of GET or POST parameters.

Body parameters in root form and JSON preview:

The endpoints of the type POST require a body parameter, that usually must be filled with a JSON object. Now in this case the list of body parameters are rendered at the root level of the form and it comes with a body preview field, that will display the JSON generated based on the user inputs. It also possible directly paste a JSON body to run the request.

POIs and body preview

POIs and body preview

Internal improvements

- The abstractions regarding the strategies to parse the swagger documentation file were improved. Now it is easier to add more parser versions and API response data extractor versions.

- The application was made compatible with the new 5.0 version of the API/core that is about to be released, reading from auto-generated swagger files.

API Playground:
https://openrouteservice.org/dev/#/api-docs
OpenRouteService:
https://openrouteservice.org

Tags: API, OpenMapSurfer, openrouteservice, Playground, POI, routing

Posted in Services, Software

Comments are closed.

  • About

    GIScience News Blog
    News of Heidelberg University’s GIScience Research Group.
    There are 1,674 Posts and 0 Comments so far.

  • Meta

    • Log in
    • Entries RSS
    • Comments RSS
    • WordPress.org
  • Recent Posts

    • New paper on the automatic characterization of surface activities from 4D point clouds
    • OSHDB Version 1.0 Has Arrived
    • Job Opening for Postdoc / Senior Researcher on OpenStreetMap Road Quality Analysis
    • Geography Awareness Week 14.-19.11.2022
    • Open Data: Multi-platform point clouds and orthophotos of the inland dune in Sandhausen
  • Tags

    3D 3DGEO Big Spatial Data CAP4Access Citizen Science Conference crisis mapping Crowdsourcing data quality deep learning disaster DisasterMapping GeoNet.MRN GIScience heigit HOT humanitarian humanitarian mapping Humanitarian OpenStreetMap team intrinsic quality analysis landuse laser scanning Lidar machine-learning Mapathon MapSwipe MissingMaps Missing Maps ohsome ohsome example Open data openrouteservice OpenStreetMap OSM OSM History Analytics Public Health Quality quality analysis remote sensing routing social media spatial analysis Teaching VGI Workshop
  • Archives

    • December 2022
    • November 2022
    • October 2022
    • September 2022
    • August 2022
    • July 2022
    • June 2022
    • May 2022
    • April 2022
    • March 2022
    • February 2022
    • January 2022
    • December 2021
    • November 2021
    • October 2021
    • September 2021
    • August 2021
    • July 2021
    • June 2021
    • May 2021
    • April 2021
    • March 2021
    • February 2021
    • January 2021
    • December 2020
    • November 2020
    • October 2020
    • September 2020
    • August 2020
    • July 2020
    • June 2020
    • May 2020
    • April 2020
    • March 2020
    • February 2020
    • January 2020
    • December 2019
    • November 2019
    • October 2019
    • September 2019
    • August 2019
    • July 2019
    • June 2019
    • May 2019
    • April 2019
    • March 2019
    • February 2019
    • January 2019
    • December 2018
    • November 2018
    • October 2018
    • September 2018
    • August 2018
    • July 2018
    • June 2018
    • May 2018
    • April 2018
    • March 2018
    • February 2018
    • January 2018
    • December 2017
    • November 2017
    • October 2017
    • September 2017
    • August 2017
    • July 2017
    • June 2017
    • May 2017
    • April 2017
    • March 2017
    • February 2017
    • January 2017
    • December 2016
    • November 2016
    • October 2016
    • September 2016
    • August 2016
    • July 2016
    • June 2016
    • May 2016
    • April 2016
    • March 2016
    • February 2016
    • January 2016
    • December 2015
    • November 2015
    • October 2015
    • September 2015
    • August 2015
    • July 2015
    • June 2015
    • May 2015
    • April 2015
    • March 2015
    • February 2015
    • January 2015
    • December 2014
    • November 2014
    • October 2014
    • September 2014
    • August 2014
    • July 2014
    • June 2014
    • May 2014
    • April 2014
    • March 2014
    • February 2014
    • January 2014
    • December 2013
    • November 2013
    • October 2013
    • September 2013
    • August 2013
    • July 2013
    • June 2013
    • May 2013
    • April 2013
  •  

    March 2019
    M T W T F S S
    « Feb   Apr »
     123
    45678910
    11121314151617
    18192021222324
    25262728293031
  • Recent Comments

    GIScience News Blog CC by-nc-sa Some Rights Reserved.

    Free WordPress Themes | Fresh WordPress Themes