Red Hat Summit2.12. ActiveDocs
3scale toolbox를 사용하여 개발자 포털에서 ActiveDocs를 생성, 업데이트, 나열 또는 삭제합니다.
2.12.1. 새 ActiveDocs 생성
OpenAPI / Swagger 준수 API 정의에서 새 ActiveDocs를 생성하려면 다음을 수행합니다.
3scale에 API 정의를 추가하고 선택적으로 이름을 지정합니다.
3scale activedocs create <remote> <activedocs-name> <spec>
ActiveDocs를 생성하는 동안 다음 옵션을 사용합니다.
Options -d --description=<value> Specify the description of the ActiveDocs -i --service-id=<value> Specify the Service ID associated to the ActiveDocs -p --published Specify it to publish the ActiveDoc on the Developer Portal. Otherwise it will be hidden -s --system-name=<value> Specify the system-name of the ActiveDocs --skip-swagger-validations Specify it to skip validation of the Swagger specification Options for ActiveDocs -c --config-file=<value> 3scale toolbox configuration file (default: $HOME/.3scalerc.yaml) -h --help show help for this command -k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Prints the version of this command --verbose Verbose mode- 개발자 포털에 정의를 게시합니다.
2.12.2. ActiveDocs 생성 또는 업데이트
다음 명령을 사용하여 새 ActiveDoc을 생성하거나 새 API 정의로 기존 ActiveDocs를 업데이트합니다.
3scale activedocs apply <remote> <activedocs_id_or_system_name>
ActiveDocs를 업데이트하는 동안 다음 옵션을 사용합니다.
Options
-d --description=<value> Specify the description of the
ActiveDocs
--hide Specify it to hide the ActiveDocs on
the Developer Portal
-i --service-id=<value> Specify the Service ID associated to
the ActiveDocs
--openapi-spec=<value> Specify the swagger spec. Can be a
file, an URL or '-' to read from
stdin. This option is mandatory when
applying the ActiveDoc for the first
time
-p --publish Specify it to publish the ActiveDocs
on the Developer Portal. Otherwise it
will be hidden
-s --name=<value> Specify the name of the ActiveDocs
--skip-swagger-validations Specify it to skip validation of the
Swagger specification
Options for ActiveDocs
-c --config-file=<value> 3scale toolbox configuration file
(default: $HOME/.3scalerc.yaml)
-h --help show help for this command
-k --insecure Proceed and operate even for server
connections otherwise considered
insecure
-v --version Prints the version of this command
--verbose Verbose mode2.12.3. ActiveDocs 나열
다음 명령을 사용하여 다음을 포함하여 개발자 포털의 모든 ActiveDocs에 대한 정보를 가져옵니다.
- id
- name
- 시스템 이름
- description
- 게시됨(개발 포털에 표시될 수 있음)
- 생성 날짜
- 최신 업데이트 날짜
다음 명령은 정의된 모든 ActiveDocs를 나열합니다.
3scale activedocs list <remote>
ActiveDocs를 나열하는 동안 다음 옵션을 사용합니다.
Options for ActiveDocs
-c --config-file=<value> 3scale toolbox configuration file
(default: $HOME/.3scalerc.yaml)
-h --help show help for this command
-k --insecure Proceed and operate even for server
connections otherwise considered insecure
-v --version Prints the version of this command
--verbose Verbose mode2.12.4. ActiveDocs 삭제
다음 명령은 ActiveDocs를 제거합니다.
3scale activedocs delete <remote> <activedocs-id_or-system-name>
ActiveDocs를 삭제하는 동안 다음 옵션을 사용합니다.
Options for ActiveDocs
-c --config-file=<value> 3scale toolbox configuration file
(default: $HOME/.3scalerc.yaml)
-h --help show help for this command
-k --insecure Proceed and operate even for server
connections otherwise considered insecure
-v --version Prints the version of this command
--verbose Verbose mode