You can directly start with "download all content", since the file generated from "get the OpenAPI TMF relative paths" is commited.
- go to https://www.tmforum.org/oda/open-apis/directory
- open the dev tools
- go to Elements -> select
<html lang="en" style>-> right click -> copy - save the copied content in a file named
output/open_api.html - format
output/open_api.htmlwith e.g. visual code formatter. We need linebreaks for the next step - extract the relevant path with
cat output/open_api.html | grep href | grep '/oda/open-apis/directory' | grep TMF | sed 's/.*href="\/oda\/open-apis\/directory\///g' | sed 's/"//g' > output/open_api_path.txt
- install python3
- execute
python3 source/fetch_tmf_api_content.py - content will be fetched to
output/TMF<number>
For efficiently browsing the content use this setup.
- Install Visual Studio Code
- Install vscode-pdf
- Install OpenAPI (Swagger) Editor
In the cli folder you find extract_definitions_from_apispec
You can use this command line tool to browse the OpenAPI schemas and extract them.
It only works on OpenAPI specs and not swagger.
Use cli/extract_definitions_from_apispec -h to explore the options.
- https://danaepp.com/how-to-extract-artifacts-from-openapi-docs-to-help-attack-apis
- https://github.com/manchenkoff/openapi3-parser
- Install java
- Download https://github.com/knutaa/oas2puml/releases/tag/Release_1.3.0
- Generate the plantuml files for a OpenAPI TMF Specification:
java -jar apidiagram-1.3.0-SNAPSHOT.jar diagrams -f TMF620-Product_Catalog_Management-v5.0.0.oas.yaml - Download https://plantuml.com/download
- Generate a diagram from the plantuml files:
java -Djava.awt.headless=true -jar plantuml.jar Resource_ProductSpecification.puml