Cross Reference: /external/chromium_org/chrome/browser/extensions/api/

This file describes steps and files needed when adding a new API to Chrome.
Before you start coding your new API, though, make sure you follow the process
described at:
  http://www.chromium.org/developers/design-documents/extensions/proposed-changes/apis-under-development

Two approaches are available for writing your API specification. The original
approach relies on JSON specification files. The more recent and simpler system
uses Web IDL files, but does not yet support all the features of the JSON files.
Discuss with a member of the extensions team (aa@chromium.org) before you decide
which approach is better suited to your API.

The following steps suppose you're writing an experimental API called "Foo".

--------------------------------------------------------------------------------
APPROACH 1: JSON FILES

1) Write your API specification.
Create "chrome/common/extensions/api/experimental_foo.json". For inspiration
look at the "app" API. Include descriptions fields to generate the
documentation.

2) Add your API specification to api.gyp.
Add "experimental_foo.json" to the "schema_files" section in
"chrome/common/extensions/api/api.gyp".

3) Write the API function handlers.
Create foo_api.cc and foo_api.h under "chrome/browser/extensions/api/foo". You
should use the JSON Schema Compiler. Look at the "permissions_api.cc" for
details on how to do that.

--------------------------------------------------------------------------------
APPROACH 2: IDL FILES

1) Write your API specification.
Create "chrome/common/extensions/api/experimental_foo.idl". For inspiration look
at "alarms.idl". Include comments, they will be used to automatically generate
the documentation.

2) Add your API specification to api.gyp.
Add "experimental_foo.idl" to the "schema_files" section in
"chrome/common/extensions/api/api.gyp".

3) Write the API function handlers.
Create foo_api.cc and foo_api.h under "chrome/browser/extensions/api/foo". You
should use the JSON Schema Compiler. Look at the "alarms_api.cc" for details on
how to do that.

--------------------------------------------------------------------------------
STEPS COMMON TO BOTH APPROACHES

6) Write support classes for your API
If your API needs any support classes add them to
"chrome/browser/extensions/api/foo". Some old APIs added their support classes
directly to chrome/browser/extensions. Don't do that.

7) Update the project with your new files.
The files you created in (3) and (5) should be added to
"chrome/chrome_browser_extensions.gypi".

--------------------------------------------------------------------------------
GENERATING DOCUMENTATION

8) Add a stub template in ../docs/templates/public corresponding to your API.
See other templates for inspiration.

9) Run ../docs/templates/server2/preview.py to view the generated documentation.

--------------------------------------------------------------------------------
WRITING TESTS

12) Write a unit test for your API.
Create "chrome/browser/extensions/api/foo/foo_api_unittest.cc" and test each of
your API methods. See "alarms_api_unittest.cc" for details. Once done add your
.cc to "chrome/chrome_tests.gypi".
Name	Date	Size
..	05-Nov-2014	24 KiB
activity_log_private/	05-Nov-2014	4 KiB
alarms/	05-Nov-2014	4 KiB
app_current_window_internal/	05-Nov-2014	4 KiB
app_window/	05-Nov-2014	4 KiB
audio/	05-Nov-2014	4 KiB
automation/	05-Nov-2014	4 KiB
automation_internal/	05-Nov-2014	4 KiB
autotest_private/	05-Nov-2014	4 KiB
bluetooth/	05-Nov-2014	4 KiB
bluetooth_low_energy/	05-Nov-2014	4 KiB
bluetooth_socket/	05-Nov-2014	4 KiB
bookmark_manager_private/	05-Nov-2014	4 KiB
bookmarks/	05-Nov-2014	4 KiB
braille_display_private/	05-Nov-2014	4 KiB
browser/	05-Nov-2014	4 KiB
browsing_data/	05-Nov-2014	4 KiB
capture_web_contents_function.cc	05-Nov-2014	4.1 KiB
capture_web_contents_function.h	05-Nov-2014	2 KiB
cast_channel/	05-Nov-2014	4 KiB
cast_streaming/	05-Nov-2014	4 KiB
chrome_extensions_api_client.cc	05-Nov-2014	1.3 KiB
chrome_extensions_api_client.h	05-Nov-2014	1.1 KiB
cloud_print_private/	05-Nov-2014	4 KiB
command_line_private/	05-Nov-2014	4 KiB
commands/	05-Nov-2014	4 KiB
content_settings/	05-Nov-2014	4 KiB
context_menus/	05-Nov-2014	4 KiB
cookies/	05-Nov-2014	4 KiB
debugger/	05-Nov-2014	4 KiB
declarative/	05-Nov-2014	4 KiB
declarative_content/	05-Nov-2014	4 KiB
declarative_webrequest/	05-Nov-2014	4 KiB
DEPS	05-Nov-2014	57
desktop_capture/	05-Nov-2014	4 KiB
developer_private/	05-Nov-2014	4 KiB
diagnostics/	05-Nov-2014	4 KiB
dial/	05-Nov-2014	4 KiB
dns/	05-Nov-2014	4 KiB
downloads/	05-Nov-2014	4 KiB
downloads_internal/	05-Nov-2014	4 KiB
enterprise_platform_keys/	05-Nov-2014	4 KiB
enterprise_platform_keys_private/	05-Nov-2014	4 KiB
execute_code_function.cc	05-Nov-2014	7.2 KiB
execute_code_function.h	05-Nov-2014	2.7 KiB
extension_action/	05-Nov-2014	4 KiB
feedback_private/	05-Nov-2014	4 KiB
file_handlers/	05-Nov-2014	4 KiB
file_system/	05-Nov-2014	4 KiB
font_settings/	05-Nov-2014	4 KiB
gcd_private/	05-Nov-2014	4 KiB
gcm/	05-Nov-2014	4 KiB
guest_view/	05-Nov-2014	4 KiB
hid/	05-Nov-2014	4 KiB
history/	05-Nov-2014	4 KiB
hotword_private/	05-Nov-2014	4 KiB
i18n/	05-Nov-2014	4 KiB
identity/	05-Nov-2014	4 KiB
identity_private/	05-Nov-2014	4 KiB
idle/	05-Nov-2014	4 KiB
idltest/	05-Nov-2014	4 KiB
image_writer_private/	05-Nov-2014	4 KiB
input/	05-Nov-2014	4 KiB
input_ime/	05-Nov-2014	4 KiB
location/	05-Nov-2014	4 KiB
log_private/	05-Nov-2014	4 KiB
management/	05-Nov-2014	4 KiB
mdns/	05-Nov-2014	4 KiB
media_galleries/	05-Nov-2014	4 KiB
media_galleries_private/	05-Nov-2014	4 KiB
messaging/	05-Nov-2014	4 KiB
metrics_private/	05-Nov-2014	4 KiB
module/	05-Nov-2014	4 KiB
music_manager_private/	05-Nov-2014	4 KiB
networking_private/	05-Nov-2014	4 KiB
notifications/	05-Nov-2014	4 KiB
omnibox/	05-Nov-2014	4 KiB
page_capture/	05-Nov-2014	4 KiB
permissions/	05-Nov-2014	4 KiB
power/	05-Nov-2014	4 KiB
preference/	05-Nov-2014	4 KiB
preferences_private/	05-Nov-2014	4 KiB
principals_private/	05-Nov-2014	4 KiB
processes/	05-Nov-2014	4 KiB
proxy/	05-Nov-2014	4 KiB
push_messaging/	05-Nov-2014	4 KiB
reading_list_private/	05-Nov-2014	4 KiB
README.txt	05-Nov-2014	3.1 KiB
recovery_private/	05-Nov-2014	4 KiB
runtime/	05-Nov-2014	4 KiB
screenlock_private/	05-Nov-2014	4 KiB
serial/	05-Nov-2014	4 KiB
sessions/	05-Nov-2014	4 KiB
settings_overrides/	05-Nov-2014	4 KiB
signed_in_devices/	05-Nov-2014	4 KiB
socket/	05-Nov-2014	4 KiB
sockets_tcp/	05-Nov-2014	4 KiB
sockets_tcp_server/	05-Nov-2014	4 KiB
sockets_udp/	05-Nov-2014	4 KiB
spellcheck/	05-Nov-2014	4 KiB
storage/	05-Nov-2014	4 KiB
streams_private/	05-Nov-2014	4 KiB
sync_file_system/	05-Nov-2014	4 KiB
synced_notifications_private/	05-Nov-2014	4 KiB
system_cpu/	05-Nov-2014	4 KiB
system_display/	05-Nov-2014	4 KiB
system_indicator/	05-Nov-2014	4 KiB
system_info/	05-Nov-2014	4 KiB
system_memory/	05-Nov-2014	4 KiB
system_network/	05-Nov-2014	4 KiB
system_private/	05-Nov-2014	4 KiB
system_storage/	05-Nov-2014	4 KiB
tab_capture/	05-Nov-2014	4 KiB
tabs/	05-Nov-2014	4 KiB
terminal/	05-Nov-2014	4 KiB
test/	05-Nov-2014	4 KiB
top_sites/	05-Nov-2014	4 KiB
web_navigation/	05-Nov-2014	4 KiB
web_request/	05-Nov-2014	4 KiB
webcam_private/	05-Nov-2014	4 KiB
webrtc_audio_private/	05-Nov-2014	4 KiB
webrtc_logging_private/	05-Nov-2014	4 KiB
webstore/	05-Nov-2014	4 KiB
webstore_private/	05-Nov-2014	4 KiB
webview/	05-Nov-2014	4 KiB