init research
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
[//]: # (title: Import Data Schemas, e.g. from OpenAPI, in Kotlin Notebook)
|
||||
|
||||
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Schemas-->
|
||||
|
||||
<warning>
|
||||
OpenAPI 3.0.0 schema support is marked as experimental. It might change or be removed in the future.
|
||||
</warning>
|
||||
|
||||
Similar to [importing OpenAPI Data Schemas in Gradle projects](schemasImportOpenApiGradle.md),
|
||||
you can also do this in Kotlin Notebook.
|
||||
This requires enabling the `enableExperimentalOpenApi` setting, like:
|
||||
```
|
||||
%use dataframe(..., enableExperimentalOpenApi=true)
|
||||
```
|
||||
|
||||
There is only a slight difference in notation:
|
||||
|
||||
Import the schema using any path (`String`), `URL`, or `File`:
|
||||
|
||||
```kotlin
|
||||
val PetStore = importDataSchema("https://petstore3.swagger.io/api/v3/openapi.json")
|
||||
```
|
||||
|
||||
and then from the next cell you run and onwards, you can call, for example:
|
||||
|
||||
```kotlin
|
||||
val df = PetStore.Pet.readJson("https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available")
|
||||
```
|
||||
|
||||
So, very similar indeed!
|
||||
|
||||
(Note: The type of `PetStore` will be generated as `PetStoreDataSchema`, but this doesn't affect the way you can use
|
||||
it.)
|
||||
Reference in New Issue
Block a user