(Check out the SAP Developer Challenge - APIs blog post for everything you need to know about the challenge to which this task relates!)
It's time to take a look at what the SAP Business Accelerator Hub has to offer in terms of APIs.
Background
The SAP Business Accelerator Hub (formerly known as the SAP Business API Hub) is the central location for all things APIs.
While APIs are key resources on there, the hub contains other types of resource too, including:
and much more.
But we're interested in APIs, which are generally organized by product, and within product, by package. For example, the SAP Business Technology Platform product has APIs, Events, Integrations, Business Process and Workflow Management resources.
Selecting the APIs category, you'll see that the APIs are organized into categories (such as SOAP, OData V2, OData V4 and REST) and presented in packages. You can see this clearly on the packages page for the SAP Business Technology Platform product:
Once you choose an API package, you will find one or more APIs, each of which have one or more endpoints, which are usually arranged into endpoint groups.
You may find this diagram, taken from the Learning about the API structure, authentication and use section of Exercise 05 - Preparing to call a Core Services API of the Hands-on with the btp CLI and APIs SAP CodeJam material serves as a helpful example of this:
+-------------+
| |
| API Package | Core Services for SAP BTP
| |
+-------------+
|
+-------------+
| |
| API | Entitlements Service
| |
+-------------+
|
+-------------+
| |
| Group | Regions for Global Account
| |
+-------------+
|
+-------------+
| |
| Endpoint | /entitlements/v1/globalAccountAllowedDataCenters
| |
+-------------+This example is from the Core Services for SAP BTP API package.
Your task
Your task is to find and explore the Date and Time API (which lives in its own dedicated package) on the SAP Business Accelerator Hub. It's in the REST category, and has an API specification available in both YAML and JSON formats. Specifically, you should download the API specification either in either of those two formats (your choice).
You should then write a script to parse the downloaded specification, to determine the API endpoints ("paths") that have both of the following properties:
- the endpoint is accessible with the HTTP GET method
- responses returned from the endpoint are in JSON
You should take that list of paths, sort them and then join them together with colons, into a single string, with no spaces. That single string is the value that you should then send to the hash function and post the resulting hash as a new reply to this discussion thread, as described in Task 0 - Learn to share your task results.
For example, if you determined that the endpoints paths that fit these conditions are:
- /endpointOne
- /endpointTwo
- /anotherEndpoint
then the string you should produce to send for hashing should be:
/anotherEndpoint:/endpointOne:/endpointTwo
Hints and tips
In order to download API specifications from the SAP Business Accelerator Hub, you'll need to be logged in. You must download them manually via the browser (i.e. rather than retrieve them via another HTTP client).
Response representations are declared using MIME types, and the MIME type for JSON is application/json.
If you want to parse YAML, and you're a JavaScript fan, you may find the js-yaml module useful.
For discussion
The API specification is available in two formats - JSON and YAML. Often for APIs there is also a third format - EDMX. Why isn't that available here?
Which API specification format did you choose, and why? Do you prefer parsing YAML or JSON?
How did you apply the endpoint conditions described above, and in what language?
I thought I'd follow up on this question. If you look at the specification files, whether in JSON or in YAML format, you'll see this at the start:
YAML:
swagger: '2.0' info: version: 1.0.0-beta title: Date and Time
JSON:
{
"swagger": "2.0",
"info": {
"version": "1.0.0-beta",
"title": "Date and Time"This then leads us to the Swagger 2.0 specification, which is here:
https://swagger.io/specification/v2/
This is where we see that the `produces` property is an array of strings, denoted by the word 'string' inside square brackets:
Chatgpt was missing my steps everytime...
This is the my final hash after verifying with others. Sorry for spaming.
604e0394f3d866a4fb3780a6ea7f233bc64a28294d9955547828a8c3251bc7ba
82249f1b31c603b7cbbcee3000ab7a1c8a3ccc3a2b6a3756d34ac4011b4b70b9
