swaggest / go-code-builder
GO code generation library
Installs: 23 939
Dependents: 2
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Language:Go
Requires
- php: >=5.6.0
- ext-json: *
- phplang/scope-exit: ^1.0
- swaggest/code-builder: ^0.3.1|dev-master
- swaggest/json-schema: ^0.12.37
- swaggest/json-schema-maker: ^0.3.2
Requires (Dev)
- phperf/phpunit: 4.8.37
- victorjonsson/markdowndocs: ^1.3
- dev-master
- v0.4.51
- v0.4.50
- v0.4.49
- v0.4.48
- v0.4.47
- v0.4.45
- v0.4.44
- v0.4.43
- v0.4.42
- v0.4.41
- v0.4.40
- v0.4.39
- v0.4.38
- v0.4.37
- v0.4.36
- v0.4.35
- v0.4.34
- v0.4.33
- v0.4.32
- v0.4.31
- v0.4.30
- v0.4.29
- v0.4.28
- v0.4.27
- v0.4.26
- v0.4.25
- v0.4.24
- v0.4.23
- v0.4.22
- v0.4.21
- v0.4.20
- v0.4.19
- v0.4.18
- v0.4.17
- v0.4.16
- v0.4.15
- v0.4.14
- v0.4.13
- v0.4.12
- v0.4.11
- v0.4.10
- v0.4.9
- v0.4.8
- v0.4.7
- v0.4.6
- v0.4.5
- v0.4.4
- v0.4.3
- v0.4.2
- v0.4.1
- v0.4.0
- v0.3.4
- v0.3.3
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.1
- v0.2.0
- v0.1.0
- dev-marshaling-roundtrip-test
- dev-go-swagger-x-go-type
- dev-json-schema-too
- dev-wip-client-2
- dev-wip-client
- dev-wip-swg
- dev-mapping
This package is auto-updated.
Last update: 2024-10-15 12:50:25 UTC
README
This library generates Go mapping structures defined by JSON schema.
Example
Generated code for schema.
<?php namespace MyApp; use Swaggest\GoCodeBuilder\JsonSchema\GoBuilder; use Swaggest\GoCodeBuilder\JsonSchema\StructHookCallback; use Swaggest\GoCodeBuilder\Templates\GoFile; use Swaggest\GoCodeBuilder\Templates\Struct\StructDef; use Swaggest\JsonSchema\Schema; require_once __DIR__ . '/vendor/autoload.php'; $schemaData = json_decode(file_get_contents(__DIR__ . '/swagger-schema.json')); $schema = Schema::import($schemaData); $builder = new GoBuilder(); $builder->structCreatedHook = new StructHookCallback(function (StructDef $structDef, $path, $schema) use ($builder) { if ('#' === $path) { $structDef->setName('SwaggerSchema'); } elseif (0 === strpos($path, '#/definitions/')) { $name = $builder->codeBuilder->exportableName(substr($path, strlen('#/definitions/'))); $structDef->setName($name); } }); $builder->getType($schema); $goFile = new GoFile('swagger'); foreach ($builder->getGeneratedStructs() as $generatedStruct) { $goFile->getCode()->addSnippet($generatedStruct->structDef); } $goFile->getCode()->addSnippet($builder->getCode());
API Documentation
Classes documentation.
Schema extensions
Magic properties (vendor extensions) defined in schema enable special handling.
x-go-type
Can have a value string or an object. Contains type reference that can be used instead of generated type.
If $ignoreXGoType
option is true
value of vendor extension is disregarded and type is generated.
Value examples:
"[]myorg.com/go-null-types::nulltypes.NullString"
"myorg.com/my-app/order.Entity"
"float64"
{"import": {"package": "my-package/domain/orders"}, "type": "Order"}
{"import": {"package": "my-package", "alias": "mp"}, "type": "Order"}
x-nullable
, nullable
If true
schema type is converted to [<type>, "null"]
. Requires $enableXNullable
option.
x-omitempty
A boolean
value to control ,omitempty
presence.
x-generate
A boolean
value to control whether property should be added to generated struct
.
Property with "x-generate": false
will be skipped.
If GoBuilder
option requireXGenerate
is set to true
only properties with "x-generate": true
will be generated.
CLI Tool
You can use json-cli to generate Go structures from command line.