Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sap/abap-file-formats-tools
Tools for the development of ABAP file formats
https://github.com/sap/abap-file-formats-tools
abap abap-file-formats
Last synced: 3 months ago
JSON representation
Tools for the development of ABAP file formats
- Host: GitHub
- URL: https://github.com/sap/abap-file-formats-tools
- Owner: SAP
- License: mit
- Created: 2022-02-15T16:06:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T10:08:50.000Z (3 months ago)
- Last Synced: 2024-10-07T10:59:12.801Z (3 months ago)
- Topics: abap, abap-file-formats
- Language: ABAP
- Homepage:
- Size: 678 KB
- Stars: 25
- Watchers: 9
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Tools for ABAP File Formats
[](https://api.reuse.software/info/github.com/SAP/abap-file-formats-tools)
## Description
ABAP file formats rely heavily on JSON Schema that are generated out of ABAP types.
This repository provides the tooling to generate such JSON Schema.
## Contributing
Comments and suggestions for improvements are most welcome.
More details are found at [Contributing](./CONTRIBUTING.md).
## Licensing
Please see our [LICENSE](LICENSE) for copyright and license information.
Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/SAP/abap-file-formats-tools).
## Download & Installation
Pull the source code with [abapGit](https://github.com/abapGit/abapGit/) into your ABAP system.
The latest abapGit build can be downloaded [here](https://raw.githubusercontent.com/abapGit/build/main/zabapgit_standalone.prog.abap).
The development of the ABAP file formats tools takes place in the `Z` namespace.
Coding policies are stated and verified by [abaplint](https://github.com/marketplace/abaplint), see configuration file [here](abaplint.jsonc), that run on every pull request.
## How to Use
This repository mainly consists of two programs:
* `z_generate_json_schema` generates JSON Schemas (minimal requirement is v7.54) from ABAP types
* `z_generate_repo` generates files and folder hierarchy for uploading and maintaining the [abap-file-formats](https://github.com/SAP/abap-file-formats) repository (requires ABAP file format framework)
To add more information to the JSON Schema than that provided by the ABAP type, ABAP Doc is parsed.
Different possibilities for adding more information via annotations are listed [here](https://github.com/SAP/abap-file-formats/blob/main/docs/json.md#writing-JSON-schema-with-ABAP-types).
Additionally to the ABAP-file-formats-related annotations, one can also use the following:
### Content Media Type
To specify the content media type of the content of a string field, the annotation
```abap
"! $contentMediaType 'mediaType'
```
followed by the media type surrounded by single quotation marks is used.
This annotation can only be used for characters like ABAP types, i.e., types that are mapped to JSON type `string`.
### Content Encoding
The encoding used to store the content of a string field can be specified with the annotation
```abap
"! $contentEncoding 'encoding'
```
followed by the encoding surrounded by single quotation marks.
Possible values for the encoding are `7bit`, `8bit`, `binary`, `quoted-printable`, `base16`, `base32` and `base64`.
This annotation can also only be used for characters like ABAP types, i.e., types that are mapped to JSON type `string`.
## How to Obtain Support
Feel free to raise issues to ask questions or report bugs.