@faizaanceg/open-sdk
v0.3.1
Published
Yet Another OpenAPI to SDK Generator
Readme
OpenSDK Generator
A flexible SDK generator that creates type-safe API client libraries from OpenAPI 3.x specifications.
Features
- Generates client libraries from OpenAPI 3.x specifications
- Supports multiple programming languages:
- TypeScript
- Java
- PHP
- Creates type-safe interfaces and models
- Generates service classes for API operations
- Handles proper file organization and dependencies
Installation
npm install @faizaanceg/open-sdkUsage
open-sdk generate --spec api-spec.json --language typescript --output ./sdkCLI Options
--spec(-S): Path to your OpenAPI specification file (required)--language(-L): Target programming language: typescript, java, or php (required)--output(-o): Output directory for the generated SDK (required)--dry-run: Preview generated files without writing to disk
Generated SDK Structure
The structure varies by language but generally includes:
TypeScript
sdk/
├── resources/ # Generated interfaces and models
├── services/ # Service classes for API operations
├── lib/ # Core library files
└── client.ts # Main entry pointJava
java/
└── com/opensdk/lib/ # Core library files
└── com/opensdk/[service]/
├── resource/ # Generated models and DTOs
├── service/ # Service interfaces and implementations
└── {service}Client.java # Main entry pointPHP
sdk/
└── OpenSDK/
├── Resource/ # Generated models and DTOs
├── Service/ # Service interfaces and implementations
├── Lib/ # Core library files
└── Client.php # Main entry pointHTTP Client Interface
The generated SDK requires an HTTP client implementation that varies by language:
TypeScript
interface OpenSDKHttpClient {
execute<T>(
method: string,
path: string,
query: Record<string, any> | null,
body: Record<string, any> | null
): Promise<T>;
}Java
public interface OpenSDKHttpClient {
<Body, Response> Response execute(RequestDescription<Body> request, Class<Response> responseType);
}Example implementation using Spring Boot's RestTemplate:
import org.springframework.web.client.RestTemplate;
import org.springframework.http.*;
import org.springframework.web.util.UriComponentsBuilder;
public class SpringOpenSDKHttpClient implements OpenSDKHttpClient {
private final RestTemplate restTemplate;
private final String baseUrl;
public SpringOpenSDKHttpClient(String baseUrl) {
this.restTemplate = new RestTemplate();
this.baseUrl = baseUrl;
}
@Override
public <Body, Response> Response execute(RequestDescription<Body> request, Class<Response> responseType) {
// Build URL with path parameters
var builder = UriComponentsBuilder
.fromHttpUrl(baseUrl)
.path(request.path())
.buildAndExpand(request.pathParams())
.toUriString();
// Add query parameters
request.query().forEach(builder::queryParam);
// Setup headers
var headers = new HttpHeaders();
request.headers().forEach(headers::addAll);
// Create request entity with body if present
HttpEntity<?> entity = request.body() != null
? new HttpEntity<>(request.body(), headers)
: new HttpEntity<>(headers);
// Execute request
var response = restTemplate.exchange(
builder.toUriString(),
HttpMethod.valueOf(request.method()),
entity,
responseType
);
return response.getBody();
}
}
// Usage example:
var client = new SpringOpenSDKHttpClient("https://api.example.com");
var sdk = new ExampleSDKClient(client);PHP
interface OpenSDKHttpClientInterface extends \Psr\Http\Client\ClientInterface {
public function execute(string $method, string $path, ?array $query, ?array $body): mixed;
}Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
Copyright 2025 N Md Faizaan
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.